Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security Policy
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

jose

package module

Go to main page

Versions in this module

v3

v3.0.6

Aug 19, 2024

v3.0.5

Aug 16, 2024

v3.0.4

Dec 14, 2023

Changes in this version

+ const A128CBC_HS256

+ const A128GCM

+ const A128GCMKW

+ const A128KW

+ const A192CBC_HS384

+ const A192GCM

+ const A192GCMKW

+ const A192KW

+ const A256CBC_HS512

+ const A256GCM

+ const A256GCMKW

+ const A256KW

+ const DEFLATE

+ const DIRECT

+ const ECDH_ES

+ const ECDH_ES_A128KW

+ const ECDH_ES_A192KW

+ const ECDH_ES_A256KW

+ const ED25519

+ const ES256

+ const ES384

+ const ES512

+ const EdDSA

+ const HS256

+ const HS384

+ const HS512

+ const HeaderContentType

+ const HeaderType

+ const NONE

+ const PBES2_HS256_A128KW

+ const PBES2_HS384_A192KW

+ const PBES2_HS512_A256KW

+ const PS256

+ const PS384

+ const PS512

+ const RS256

+ const RS384

+ const RS512

+ const RSA1_5

+ const RSA_OAEP

+ const RSA_OAEP_256

+ var ErrCryptoFailure = errors.New("go-jose/go-jose: error in cryptographic primitive")

+ var ErrInvalidKeySize = errors.New("go-jose/go-jose: invalid key size for algorithm")

+ var ErrNotSupported = errors.New("go-jose/go-jose: compact serialization not supported for object")

+ var ErrUnprotectedNonce = errors.New("go-jose/go-jose: Nonce parameter included in unprotected header")

+ var ErrUnsupportedAlgorithm = errors.New("go-jose/go-jose: unknown/unsupported algorithm")

+ var ErrUnsupportedKeyType = errors.New("go-jose/go-jose: unsupported key type/format")

+ var RandReader = rand.Reader

+ type CompressionAlgorithm string

+ type ContentEncryption string

+ type ContentType string

+ type Encrypter interface

+ Encrypt func(plaintext []byte) (*JSONWebEncryption, error)

+ EncryptWithAuthData func(plaintext []byte, aad []byte) (*JSONWebEncryption, error)

+ Options func() EncrypterOptions

+ func NewEncrypter(enc ContentEncryption, rcpt Recipient, opts *EncrypterOptions) (Encrypter, error)

+ func NewMultiEncrypter(enc ContentEncryption, rcpts []Recipient, opts *EncrypterOptions) (Encrypter, error)

+ type EncrypterOptions struct

+ Compression CompressionAlgorithm

+ ExtraHeaders map[HeaderKey]interface{}

+ func (eo *EncrypterOptions) WithContentType(contentType ContentType) *EncrypterOptions

+ func (eo *EncrypterOptions) WithHeader(k HeaderKey, v interface{}) *EncrypterOptions

+ func (eo *EncrypterOptions) WithType(typ ContentType) *EncrypterOptions

+ type Header struct

+ Algorithm string

+ ExtraHeaders map[HeaderKey]interface{}

+ JSONWebKey *JSONWebKey

+ KeyID string

+ Nonce string

+ func (h Header) Certificates(opts x509.VerifyOptions) ([][]*x509.Certificate, error)

+ type HeaderKey string

+ type JSONWebEncryption struct

+ Header Header

+ func ParseEncrypted(input string) (*JSONWebEncryption, error)

+ func (obj JSONWebEncryption) CompactSerialize() (string, error)

+ func (obj JSONWebEncryption) Decrypt(decryptionKey interface{}) ([]byte, error)

+ func (obj JSONWebEncryption) DecryptMulti(decryptionKey interface{}) (int, Header, []byte, error)

+ func (obj JSONWebEncryption) FullSerialize() string

+ func (obj JSONWebEncryption) GetAuthData() []byte

+ type JSONWebKey struct

+ Algorithm string

+ CertificateThumbprintSHA1 []byte

+ CertificateThumbprintSHA256 []byte

+ Certificates []*x509.Certificate

+ CertificatesURL *url.URL

+ Key interface{}

+ KeyID string

+ Use string

+ func (k *JSONWebKey) IsPublic() bool

+ func (k *JSONWebKey) Public() JSONWebKey

+ func (k *JSONWebKey) Thumbprint(hash crypto.Hash) ([]byte, error)

+ func (k *JSONWebKey) UnmarshalJSON(data []byte) (err error)

+ func (k *JSONWebKey) Valid() bool

+ func (k JSONWebKey) MarshalJSON() ([]byte, error)

+ type JSONWebKeySet struct

+ Keys []JSONWebKey

+ func (s *JSONWebKeySet) Key(kid string) []JSONWebKey

+ type JSONWebSignature struct

+ Signatures []Signature

+ func ParseDetached(signature string, payload []byte) (*JSONWebSignature, error)

+ func ParseSigned(signature string) (*JSONWebSignature, error)

+ func (obj JSONWebSignature) CompactSerialize() (string, error)

+ func (obj JSONWebSignature) DetachedCompactSerialize() (string, error)

+ func (obj JSONWebSignature) DetachedVerify(payload []byte, verificationKey interface{}) error

+ func (obj JSONWebSignature) DetachedVerifyCOP(payload []byte, verificationKey interface{}) error

+ func (obj JSONWebSignature) DetachedVerifyMulti(payload []byte, verificationKey interface{}) (int, Signature, error)

+ func (obj JSONWebSignature) FullSerialize() string

+ func (obj JSONWebSignature) UnsafePayloadWithoutVerification() []byte

+ func (obj JSONWebSignature) Verify(verificationKey interface{}) ([]byte, error)

+ func (obj JSONWebSignature) VerifyCOP(verificationKey interface{}) ([]byte, error)

+ func (obj JSONWebSignature) VerifyMulti(verificationKey interface{}) (int, Signature, []byte, error)

+ type KeyAlgorithm string

+ type NonceSource interface

+ Nonce func() (string, error)

+ type OpaqueKeyDecrypter interface

+ DecryptKey func(encryptedKey []byte, header Header) ([]byte, error)

+ type OpaqueKeyEncrypter interface

+ Algs func() []KeyAlgorithm

+ KeyID func() string

+ type OpaqueSigner interface

+ Algs func() []SignatureAlgorithm

+ Public func() *JSONWebKey

+ SignPayload func(payload []byte, alg SignatureAlgorithm) ([]byte, error)

+ type OpaqueVerifier interface

+ VerifyPayload func(payload []byte, signature []byte, alg SignatureAlgorithm) error

+ type Recipient struct

+ Algorithm KeyAlgorithm

+ Key interface{}

+ KeyID string

+ PBES2Count int

+ PBES2Salt []byte

+ type Signature struct

+ Header Header

+ Protected Header

+ Signature []byte

+ Unprotected Header

+ type SignatureAlgorithm string

+ type Signer interface

+ Options func() SignerOptions

+ Sign func(payload []byte) (*JSONWebSignature, error)

+ func NewMultiSigner(sigs []SigningKey, opts *SignerOptions) (Signer, error)

+ func NewSigner(sig SigningKey, opts *SignerOptions) (Signer, error)

+ type SignerOptions struct

+ EmbedJWK bool

+ ExtraHeaders map[HeaderKey]interface{}

+ NonceSource NonceSource

+ func (so *SignerOptions) WithBase64(b64 bool) *SignerOptions

+ func (so *SignerOptions) WithContentType(contentType ContentType) *SignerOptions

+ func (so *SignerOptions) WithCritical(names ...string) *SignerOptions

+ func (so *SignerOptions) WithHeader(k HeaderKey, v interface{}) *SignerOptions

+ func (so *SignerOptions) WithType(typ ContentType) *SignerOptions

+ type SigningKey struct

+ Algorithm SignatureAlgorithm

+ Key interface{}

Other modules containing this package

github.com/karfrank/go-jose