diff --git a/README.md b/README.md index 1544790..bce16fc 100644 --- a/README.md +++ b/README.md @@ -65,21 +65,21 @@ import ( ## Packages -| Package name | Import | Description | -|--------------------------------------------------------|--------------------------------|--------------------------------| -| [cose](https://pkg.go.dev/github.com/ldclabs/cose/cose) | github.com/ldclabs/cose/cose | [RFC9052: CBOR Object Signing and Encryption][cose-spec] | -| [cwt](https://pkg.go.dev/github.com/ldclabs/cose/cwt) | github.com/ldclabs/cose/cwt | [RFC8392: CBOR Web Token][cwt-spec] | -| [iana](https://pkg.go.dev/github.com/ldclabs/cose/iana) | github.com/ldclabs/cose/iana | [IANA: COSE][iana-cose] + [IANA: CWT][iana-cwt] + [IANA: CBOR Tags][iana-cbor-tags]| -| [key](https://pkg.go.dev/github.com/ldclabs/cose/key) | github.com/ldclabs/cose/key | [RFC9053: Algorithms and Key Objects][algorithms-spec] | -| [ed25519](https://pkg.go.dev/github.com/ldclabs/cose/key/ed25519) | github.com/ldclabs/cose/key/ed25519 | Signature Algorithm: [Ed25519](https://datatracker.ietf.org/doc/html/rfc9053#name-edwards-curve-digital-signa) | -| [ecdsa](https://pkg.go.dev/github.com/ldclabs/cose/key/ecdsa) | github.com/ldclabs/cose/key/ecdsa | Signature Algorithm: [ECDSA](https://datatracker.ietf.org/doc/html/rfc9053#name-ecdsa) | -| [ecdh](https://pkg.go.dev/github.com/ldclabs/cose/key/ecdh) | github.com/ldclabs/cose/key/ecdh | Elliptic Curve Diffie-Hellman Algorithm: [ECDH](https://datatracker.ietf.org/doc/html/rfc9053#name-direct-key-agreement) | -| [hmac](https://pkg.go.dev/github.com/ldclabs/cose/key/hmac) | github.com/ldclabs/cose/key/hmac | Message Authentication Code (MAC) Algorithm: [HMAC](https://datatracker.ietf.org/doc/html/rfc9053#name-hash-based-message-authenti) | -| [aesmac](https://pkg.go.dev/github.com/ldclabs/cose/key/aesmac) | github.com/ldclabs/cose/key/aesmac | Message Authentication Code (MAC) Algorithm: [AES-CBC-MAC](https://datatracker.ietf.org/doc/html/rfc9053#name-hash-based-message-authenti) | -| [aesgcm](https://pkg.go.dev/github.com/ldclabs/cose/key/aesgcm) | github.com/ldclabs/cose/key/aesgcm | Content Encryption Algorithm: [AES-GCM](https://datatracker.ietf.org/doc/html/rfc9053#name-aes-gcm) | -| [aesccm](https://pkg.go.dev/github.com/ldclabs/cose/key/aesccm) | github.com/ldclabs/cose/key/aesccm | Content Encryption Algorithm: [AES-CCM](https://datatracker.ietf.org/doc/html/rfc9053#name-aes-ccm) | -| [chacha20poly1305](https://pkg.go.dev/github.com/ldclabs/cose/key/chacha20poly1305) | github.com/ldclabs/cose/key/chacha20poly1305 | Content Encryption Algorithm: [ChaCha20/Poly1305](https://datatracker.ietf.org/doc/html/rfc9053#name-chacha20-and-poly1305) | -| [hkdf](https://pkg.go.dev/github.com/ldclabs/cose/key/hkdf) | github.com/ldclabs/cose/key/hkdf | Key Derivation Functions (KDFs) Algorithm: [HKDF](https://datatracker.ietf.org/doc/html/rfc9053#name-key-derivation-functions-kd) | +| Package name | Import | Description | +| ----------------------------------------------------------------------------------- | -------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------ | +| [cose](https://pkg.go.dev/github.com/ldclabs/cose/cose) | github.com/ldclabs/cose/cose | [RFC9052: CBOR Object Signing and Encryption][cose-spec] | +| [cwt](https://pkg.go.dev/github.com/ldclabs/cose/cwt) | github.com/ldclabs/cose/cwt | [RFC8392: CBOR Web Token][cwt-spec] | +| [iana](https://pkg.go.dev/github.com/ldclabs/cose/iana) | github.com/ldclabs/cose/iana | [IANA: COSE][iana-cose] + [IANA: CWT][iana-cwt] + [IANA: CBOR Tags][iana-cbor-tags] | +| [key](https://pkg.go.dev/github.com/ldclabs/cose/key) | github.com/ldclabs/cose/key | [RFC9053: Algorithms and Key Objects][algorithms-spec] | +| [ed25519](https://pkg.go.dev/github.com/ldclabs/cose/key/ed25519) | github.com/ldclabs/cose/key/ed25519 | Signature Algorithm: [Ed25519](https://datatracker.ietf.org/doc/html/rfc9053#name-edwards-curve-digital-signa) | +| [ecdsa](https://pkg.go.dev/github.com/ldclabs/cose/key/ecdsa) | github.com/ldclabs/cose/key/ecdsa | Signature Algorithm: [ECDSA](https://datatracker.ietf.org/doc/html/rfc9053#name-ecdsa) | +| [ecdh](https://pkg.go.dev/github.com/ldclabs/cose/key/ecdh) | github.com/ldclabs/cose/key/ecdh | Elliptic Curve Diffie-Hellman Algorithm: [ECDH](https://datatracker.ietf.org/doc/html/rfc9053#name-direct-key-agreement) | +| [hmac](https://pkg.go.dev/github.com/ldclabs/cose/key/hmac) | github.com/ldclabs/cose/key/hmac | Message Authentication Code (MAC) Algorithm: [HMAC](https://datatracker.ietf.org/doc/html/rfc9053#name-hash-based-message-authenti) | +| [aesmac](https://pkg.go.dev/github.com/ldclabs/cose/key/aesmac) | github.com/ldclabs/cose/key/aesmac | Message Authentication Code (MAC) Algorithm: [AES-CBC-MAC](https://datatracker.ietf.org/doc/html/rfc9053#name-hash-based-message-authenti) | +| [aesgcm](https://pkg.go.dev/github.com/ldclabs/cose/key/aesgcm) | github.com/ldclabs/cose/key/aesgcm | Content Encryption Algorithm: [AES-GCM](https://datatracker.ietf.org/doc/html/rfc9053#name-aes-gcm) | +| [aesccm](https://pkg.go.dev/github.com/ldclabs/cose/key/aesccm) | github.com/ldclabs/cose/key/aesccm | Content Encryption Algorithm: [AES-CCM](https://datatracker.ietf.org/doc/html/rfc9053#name-aes-ccm) | +| [chacha20poly1305](https://pkg.go.dev/github.com/ldclabs/cose/key/chacha20poly1305) | github.com/ldclabs/cose/key/chacha20poly1305 | Content Encryption Algorithm: [ChaCha20/Poly1305](https://datatracker.ietf.org/doc/html/rfc9053#name-chacha20-and-poly1305) | +| [hkdf](https://pkg.go.dev/github.com/ldclabs/cose/key/hkdf) | github.com/ldclabs/cose/key/hkdf | Key Derivation Functions (KDFs) Algorithm: [HKDF](https://datatracker.ietf.org/doc/html/rfc9053#name-key-derivation-functions-kd) | ## Examples @@ -276,4 +276,4 @@ Todo. ## License Copyright © 2022-2023 [LDC Labs](https://github.com/ldclabs). -ldclabs/cose is licensed under the MIT License. See [LICENSE](LICENSE) for the full license text. \ No newline at end of file +ldclabs/cose is licensed under the MIT License. See [LICENSE](LICENSE) for the full license text. \ No newline at end of file