jwe

Documentation

Overview

This file is auto-generated by internal/cmd/genheaders/main.go. DO NOT EDIT

Package jwe implements JWE as described in https://tools.ietf.org/html/rfc7516

Index

• Constants
• func Compact(m *Message, _ ...Option) ([]byte, error)
• func Decrypt(buf []byte, alg jwa.KeyEncryptionAlgorithm, key interface{}) ([]byte, error)
• func Encrypt(payload []byte, keyalg jwa.KeyEncryptionAlgorithm, key interface{}, ...) ([]byte, error)
• func JSON(m *Message, options ...Option) ([]byte, error)
• type HeaderPair
• type Headers
  • func NewHeaders() Headers
• type Iterator
• type Message
  • func NewMessage() *Message
  • func Parse(buf []byte) (*Message, error)
  • func ParseString(s string) (*Message, error)
  • func (m *Message) AuthenticatedData() buffer.Buffer
  • func (m *Message) CipherText() buffer.Buffer
  • func (m *Message) Decrypt(alg jwa.KeyEncryptionAlgorithm, key interface{}) ([]byte, error)
  • func (m *Message) InitializationVector() buffer.Buffer
  • func (m *Message) MarshalJSON() ([]byte, error)
  • func (m *Message) ProtectedHeaders() Headers
  • func (m *Message) Recipients() []Recipient
  • func (m *Message) UnmarshalJSON(buf []byte) error
  • func (m *Message) UnprotectedHeaders() Headers
• type Option
  • func WithPrettyJSONFormat(b bool) Option
• type Recipient
  • func NewRecipient() Recipient
• type Visitor
• type VisitorFunc

Examples

• Encrypt

Constants

const (
	AgreementPartyUInfoKey    = "apu"
	AgreementPartyVInfoKey    = "apv"
	AlgorithmKey              = "alg"
	CompressionKey            = "zip"
	ContentEncryptionKey      = "enc"
	ContentTypeKey            = "cty"
	CriticalKey               = "crit"
	EphemeralPublicKeyKey     = "epk"
	JWKKey                    = "jwk"
	JWKSetURLKey              = "jku"
	KeyIDKey                  = "kid"
	TypeKey                   = "typ"
	X509CertChainKey          = "x5c"
	X509CertThumbprintKey     = "x5t"
	X509CertThumbprintS256Key = "x5t#S256"
	X509URLKey                = "x5u"
)

const (
	AuthenticatedDataKey    = "aad"
	CipherTextKey           = "ciphertext"
	InitializationVectorKey = "iv"
	ProtectedHeadersKey     = "protected"
	RecipientsKey           = "recipients"
	TagKey                  = "tag"
	UnprotectedHeadersKey   = "unprotected"
)

Functions

func Compact

func Compact(m *Message, _ ...Option) ([]byte, error)

Compact encodes the given message into a JWE compact serialization format.

func Decrypt

func Decrypt(buf []byte, alg jwa.KeyEncryptionAlgorithm, key interface{}) ([]byte, error)

Decrypt takes the key encryption algorithm and the corresponding key to decrypt the JWE message, and returns the decrypted payload. The JWE message can be either compact or full JSON format.

func Encrypt

func Encrypt(payload []byte, keyalg jwa.KeyEncryptionAlgorithm, key interface{}, contentalg jwa.ContentEncryptionAlgorithm, compressalg jwa.CompressionAlgorithm) ([]byte, error)

Encrypt takes the plaintext payload and encrypts it in JWE compact format.

Example

privkey, err := rsa.GenerateKey(rand.Reader, 2048)
if err != nil {
	log.Printf("failed to generate private key: %s", err)
	return
}

payload := []byte("Lorem Ipsum")

encrypted, err := Encrypt(payload, jwa.RSA1_5, &privkey.PublicKey, jwa.A128CBC_HS256, jwa.NoCompress)
if err != nil {
	log.Printf("failed to encrypt payload: %s", err)
	return
}

decrypted, err := Decrypt(encrypted, jwa.RSA1_5, privkey)
if err != nil {
	log.Printf("failed to decrypt: %s", err)
	return
}

if string(decrypted) != "Lorem Ipsum" {
	log.Printf("WHAT?!")
	return
}

func JSON

func JSON(m *Message, options ...Option) ([]byte, error)

JSON encodes the message into a JWE JSON serialization format.

Types

type HeaderPair

type HeaderPair = mapiter.Pair

type Headers

type Headers interface {
	AgreementPartyUInfo() buffer.Buffer
	AgreementPartyVInfo() buffer.Buffer
	Algorithm() jwa.KeyEncryptionAlgorithm
	Compression() jwa.CompressionAlgorithm
	ContentEncryption() jwa.ContentEncryptionAlgorithm
	ContentType() string
	Critical() []string
	EphemeralPublicKey() jwk.ECDSAPublicKey
	JWK() jwk.Key
	JWKSetURL() string
	KeyID() string
	Type() string
	X509CertChain() []string
	X509CertThumbprint() string
	X509CertThumbprintS256() string
	X509URL() string
	Iterate(ctx context.Context) Iterator
	Walk(ctx context.Context, v Visitor) error
	AsMap(ctx context.Context) (map[string]interface{}, error)
	Get(string) (interface{}, bool)
	Set(string, interface{}) error
	Remove(string) error
	Encode() ([]byte, error)
	Decode([]byte) error
}

Headers describe a standard Header set.

func NewHeaders

func NewHeaders() Headers

type Iterator

type Iterator = mapiter.Iterator

type Message

type Message struct {
	// contains filtered or unexported fields
}

Message contains the entire encrypted JWE message

func NewMessage

func NewMessage() *Message

NewMessage creates a new message

func Parse

func Parse(buf []byte) (*Message, error)

Parse parses the JWE message into a Message object. The JWE message can be either compact or full JSON format.

func ParseString

func ParseString(s string) (*Message, error)

ParseString is the same as Parse, but takes a string.

func (*Message) AuthenticatedData

func (m *Message) AuthenticatedData() buffer.Buffer

func (*Message) CipherText

func (m *Message) CipherText() buffer.Buffer

func (*Message) Decrypt

func (m *Message) Decrypt(alg jwa.KeyEncryptionAlgorithm, key interface{}) ([]byte, error)

Decrypt decrypts the message using the specified algorithm and key

func (*Message) InitializationVector

func (m *Message) InitializationVector() buffer.Buffer

func (*Message) MarshalJSON

func (m *Message) MarshalJSON() ([]byte, error)

func (*Message) ProtectedHeaders

func (m *Message) ProtectedHeaders() Headers

func (*Message) Recipients

func (m *Message) Recipients() []Recipient

func (*Message) UnmarshalJSON

func (m *Message) UnmarshalJSON(buf []byte) error

func (*Message) UnprotectedHeaders

func (m *Message) UnprotectedHeaders() Headers

type Option

type Option = option.Interface

func WithPrettyJSONFormat

func WithPrettyJSONFormat(b bool) Option

WithPrettyJSONFormat specifies if the `jwe.JSON` serialization tool should generate pretty-formatted output

type Recipient

type Recipient interface {
	Headers() Headers
	EncryptedKey() buffer.Buffer
	SetHeaders(Headers) error
	SetEncryptedKey(interface{}) error
}

Recipient holds the encrypted key and hints to decrypt the key

func NewRecipient

func NewRecipient() Recipient

NewRecipient creates a Recipient object

type Visitor

type Visitor = iter.MapVisitor

type VisitorFunc

type VisitorFunc = iter.MapVisitorFunc