package cipher

Import Path
	crypto/cipher (on golang.org and go.dev)

Dependency Relation
	imports 5 packages, and imported by 8 packages

Involved Source Files cbc.go cfb.go Package cipher implements standard block cipher modes that can be wrapped around low-level block cipher implementations. See https://csrc.nist.gov/groups/ST/toolkit/BCM/current_modes.html and NIST Special Publication 800-38A. ctr.go gcm.go io.go ofb.go xor_amd64.go xor_amd64.s
Package-Level Type Names (total 6)
/* sort by: | */
AEAD is a cipher mode providing authenticated encryption with associated data. For a description of the methodology, see https://en.wikipedia.org/wiki/Authenticated_encryption NonceSize returns the size of the nonce that must be passed to Seal and Open. Open decrypts and authenticates ciphertext, authenticates the additional data and, if successful, appends the resulting plaintext to dst, returning the updated slice. The nonce must be NonceSize() bytes long and both it and the additional data must match the value passed to Seal. To reuse ciphertext's storage for the decrypted output, use ciphertext[:0] as dst. Otherwise, the remaining capacity of dst must not overlap plaintext. Even if the function fails, the contents of dst, up to its capacity, may be overwritten. Overhead returns the maximum difference between the lengths of a plaintext and its ciphertext. Seal encrypts and authenticates plaintext, authenticates the additional data and appends the result to dst, returning the updated slice. The nonce must be NonceSize() bytes long and unique for all time, for a given key. To reuse plaintext's storage for the encrypted output, use plaintext[:0] as dst. Otherwise, the remaining capacity of dst must not overlap plaintext. func NewGCM(cipher Block) (AEAD, error) func NewGCMWithNonceSize(cipher Block, size int) (AEAD, error) func NewGCMWithTagSize(cipher Block, tagSize int) (AEAD, error) func vendor/golang.org/x/crypto/chacha20poly1305.New(key []byte) (AEAD, error) func vendor/golang.org/x/crypto/chacha20poly1305.NewX(key []byte) (AEAD, error)
A Block represents an implementation of block cipher using a given key. It provides the capability to encrypt or decrypt individual blocks. The mode implementations extend that capability to streams of blocks. BlockSize returns the cipher's block size. Decrypt decrypts the first block in src into dst. Dst and src must overlap entirely or not at all. Encrypt encrypts the first block in src into dst. Dst and src must overlap entirely or not at all. func crypto/aes.NewCipher(key []byte) (Block, error) func crypto/des.NewCipher(key []byte) (Block, error) func crypto/des.NewTripleDESCipher(key []byte) (Block, error) func NewCBCDecrypter(b Block, iv []byte) BlockMode func NewCBCEncrypter(b Block, iv []byte) BlockMode func NewCFBDecrypter(block Block, iv []byte) Stream func NewCFBEncrypter(block Block, iv []byte) Stream func NewCTR(block Block, iv []byte) Stream func NewGCM(cipher Block) (AEAD, error) func NewGCMWithNonceSize(cipher Block, size int) (AEAD, error) func NewGCMWithTagSize(cipher Block, tagSize int) (AEAD, error) func NewOFB(b Block, iv []byte) Stream
A BlockMode represents a block cipher running in a block-based mode (CBC, ECB etc). BlockSize returns the mode's block size. CryptBlocks encrypts or decrypts a number of blocks. The length of src must be a multiple of the block size. Dst and src must overlap entirely or not at all. If len(dst) < len(src), CryptBlocks should panic. It is acceptable to pass a dst bigger than src, and in that case, CryptBlocks will only update dst[:len(src)] and will not touch the rest of dst. Multiple calls to CryptBlocks behave as if the concatenation of the src buffers was passed in a single run. That is, BlockMode maintains state and does not reset at each CryptBlocks call. func NewCBCDecrypter(b Block, iv []byte) BlockMode func NewCBCEncrypter(b Block, iv []byte) BlockMode
A Stream represents a stream cipher. XORKeyStream XORs each byte in the given slice with a byte from the cipher's key stream. Dst and src must overlap entirely or not at all. If len(dst) < len(src), XORKeyStream should panic. It is acceptable to pass a dst bigger than src, and in that case, XORKeyStream will only update dst[:len(src)] and will not touch the rest of dst. Multiple calls to XORKeyStream behave as if the concatenation of the src buffers was passed in a single run. That is, Stream maintains state and does not reset at each XORKeyStream call. *crypto/rc4.Cipher *vendor/golang.org/x/crypto/chacha20.Cipher func NewCFBDecrypter(block Block, iv []byte) Stream func NewCFBEncrypter(block Block, iv []byte) Stream func NewCTR(block Block, iv []byte) Stream func NewOFB(b Block, iv []byte) Stream
StreamReader wraps a Stream into an io.Reader. It calls XORKeyStream to process each slice of data which passes through. R io.Reader S Stream ( T) Read(dst []byte) (n int, err error) T : io.Reader
StreamWriter wraps a Stream into an io.Writer. It calls XORKeyStream to process each slice of data which passes through. If any Write call returns short then the StreamWriter is out of sync and must be discarded. A StreamWriter has no internal buffering; Close does not need to be called to flush write data. // unused S Stream W io.Writer Close closes the underlying Writer and returns its Close return value, if the Writer is also an io.Closer. Otherwise it returns nil. ( T) Write(src []byte) (n int, err error) T : io.Closer T : io.WriteCloser T : io.Writer
Package-Level Functions (total 9)
NewCBCDecrypter returns a BlockMode which decrypts in cipher block chaining mode, using the given Block. The length of iv must be the same as the Block's block size and must match the iv used to encrypt the data.
NewCBCEncrypter returns a BlockMode which encrypts in cipher block chaining mode, using the given Block. The length of iv must be the same as the Block's block size.
NewCFBDecrypter returns a Stream which decrypts with cipher feedback mode, using the given Block. The iv must be the same length as the Block's block size.
NewCFBEncrypter returns a Stream which encrypts with cipher feedback mode, using the given Block. The iv must be the same length as the Block's block size.
NewCTR returns a Stream which encrypts/decrypts using the given Block in counter mode. The length of iv must be the same as the Block's block size.
NewGCM returns the given 128-bit, block cipher wrapped in Galois Counter Mode with the standard nonce length. In general, the GHASH operation performed by this implementation of GCM is not constant-time. An exception is when the underlying Block was created by aes.NewCipher on systems with hardware support for AES. See the crypto/aes package documentation for details.
NewGCMWithNonceSize returns the given 128-bit, block cipher wrapped in Galois Counter Mode, which accepts nonces of the given length. The length must not be zero. Only use this function if you require compatibility with an existing cryptosystem that uses non-standard nonce lengths. All other users should use NewGCM, which is faster and more resistant to misuse.
NewGCMWithTagSize returns the given 128-bit, block cipher wrapped in Galois Counter Mode, which generates tags with the given length. Tag sizes between 12 and 16 bytes are allowed. Only use this function if you require compatibility with an existing cryptosystem that uses non-standard tag lengths. All other users should use NewGCM, which is more resistant to misuse.
NewOFB returns a Stream that encrypts or decrypts using the block cipher b in output feedback mode. The initialization vector iv's length must be equal to b's block size.