Skip to content

Commit

Permalink
Merge pull request #49 from pavlo-v-chernykh/add-used-by-section-in-r…
Browse files Browse the repository at this point in the history
…eadme

Update README.md
  • Loading branch information
pavlo-v-chernykh authored Jun 4, 2024
2 parents ae44a5e + 56769bf commit b165f90
Showing 1 changed file with 33 additions and 76 deletions.
109 changes: 33 additions & 76 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,87 +5,44 @@ A go (golang) implementation of Java [KeyStore][1] encoder/decoder

Take into account that JKS assumes that private keys are PKCS8 encoded.

### Example

```go
package main

import (
"log"
"os"
"reflect"

"github.com/pavlo-v-chernykh/keystore-go/v4"
)

func readKeyStore(filename string, password []byte) keystore.KeyStore {
f, err := os.Open(filename)
if err != nil {
log.Fatal(err)
}

defer func() {
if err := f.Close(); err != nil {
log.Fatal(err)
}
}()

ks := keystore.New()
if err := ks.Load(f, password); err != nil {
log.Fatal(err) //nolint: gocritic
}

return ks
}

func writeKeyStore(ks keystore.KeyStore, filename string, password []byte) {
f, err := os.Create(filename)
if err != nil {
log.Fatal(err)
}

defer func() {
if err := f.Close(); err != nil {
log.Fatal(err)
}
}()

err = ks.Store(f, password)
if err != nil {
log.Fatal(err) //nolint: gocritic
}
}

func zeroing(buf []byte) {
for i := range buf {
buf[i] = 0
}
}

func main() {
password := []byte{'p', 'a', 's', 's', 'w', 'o', 'r', 'd'}
defer zeroing(password)

ks1 := readKeyStore("keystore.jks", password)

writeKeyStore(ks1, "keystore2.jks", password)

ks2 := readKeyStore("keystore2.jks", password)

log.Printf("is equal: %v\n", reflect.DeepEqual(ks1, ks2))
}
```

For more examples explore [examples](examples) dir
## Example

For examples explore [examples](examples) directory

## Used by

[cert-manager/cert-manager][2]

[yugabyte/yugabyte-db][3]

[banzaicloud/koperator][4]

[paketo-buildpacks/spring-boot][5]

[paketo-buildpacks/libjvm][6]

[paketo-buildpacks/graalvm][7]

[arangodb/arangosync-client][8]

and [others][9]

## Development

1. Install [go][2]
2. Install [golangci-lint][3]
1. Install [go][10]
2. Install [golangci-lint][11]
3. Clone the repo `git clone git@github.com:pavlo-v-chernykh/keystore-go.git`
4. Go to the project dir `cd keystore-go`
5. Run `make` to format, test and lint

[1]: https://docs.oracle.com/javase/7/docs/technotes/guides/security/crypto/CryptoSpec.html#KeyManagement
[2]: https://golang.org
[3]: https://github.com/golangci/golangci-lint
[2]: https://github.com/cert-manager/cert-manager
[3]: https://github.com/yugabyte/yugabyte-db
[4]: https://github.com/banzaicloud/koperator
[5]: https://github.com/paketo-buildpacks/spring-boot
[6]: https://github.com/paketo-buildpacks/libjvm
[7]: https://github.com/paketo-buildpacks/graalvm
[8]: https://github.com/arangodb/arangosync-client
[9]: https://github.com/pavlo-v-chernykh/keystore-go/network/dependents
[10]: https://golang.org
[11]: https://github.com/golangci/golangci-lint

0 comments on commit b165f90

Please sign in to comment.