package sha3

Import Path
	crypto/sha3 (on go.dev)

Dependency Relation
	imports 3 packages, and imported by 0 packages


Involved Source Files

	
		Package sha3 implements the SHA-3 hash algorithms and the SHAKE extendable
		output functions defined in FIPS 202.


Package-Level Type Names (total 2)


	/* sort by:  |  */
	
		SHA3 is an instance of a SHA-3 hash. It implements [hash.Hash].

		
			
				AppendBinary implements [encoding.BinaryAppender].

			
				BlockSize returns the hash's rate.

			
				MarshalBinary implements [encoding.BinaryMarshaler].

			
				Reset resets the hash to its initial state.

			
				Size returns the number of bytes Sum will produce.

			
				Sum appends the current hash to b and returns the resulting slice.

			
				UnmarshalBinary implements [encoding.BinaryUnmarshaler].

			
				Write absorbs more data into the hash's state.

		
			*SHA3 : crypto/internal/fips140.Hash
			*SHA3 : encoding.BinaryAppender
			*SHA3 : encoding.BinaryMarshaler
			*SHA3 : encoding.BinaryUnmarshaler
			*SHA3 : hash.Hash
			*SHA3 : internal/bisect.Writer
			*SHA3 : io.Writer
		
			func New224() *SHA3
			func New256() *SHA3
			func New384() *SHA3
			func New512() *SHA3


	
		SHAKE is an instance of a SHAKE extendable output function.

		
			
				AppendBinary implements [encoding.BinaryAppender].

			
				BlockSize returns the rate of the XOF.

			
				MarshalBinary implements [encoding.BinaryMarshaler].

			
				Read squeezes more output from the XOF.
				
				Any call to Write after a call to Read will panic.

			
				Reset resets the XOF to its initial state.

			
				UnmarshalBinary implements [encoding.BinaryUnmarshaler].

			
				Write absorbs more data into the XOF's state.
				
				It panics if any output has already been read.

		
			*SHAKE : encoding.BinaryAppender
			*SHAKE : encoding.BinaryMarshaler
			*SHAKE : encoding.BinaryUnmarshaler
			*SHAKE : internal/bisect.Writer
			*SHAKE : io.Reader
			*SHAKE : io.ReadWriter
			*SHAKE : io.Writer
		
			func NewCSHAKE128(N, S []byte) *SHAKE
			func NewCSHAKE256(N, S []byte) *SHAKE
			func NewSHAKE128() *SHAKE
			func NewSHAKE256() *SHAKE




Package-Level Functions (total 14)


	
		New224 creates a new SHA3-224 hash.


	
		New256 creates a new SHA3-256 hash.


	
		New384 creates a new SHA3-384 hash.


	
		New512 creates a new SHA3-512 hash.


	
		NewCSHAKE128 creates a new cSHAKE128 XOF.
		
		N is used to define functions based on cSHAKE, it can be empty when plain
		cSHAKE is desired. S is a customization byte string used for domain
		separation. When N and S are both empty, this is equivalent to NewSHAKE128.


	
		NewCSHAKE256 creates a new cSHAKE256 XOF.
		
		N is used to define functions based on cSHAKE, it can be empty when plain
		cSHAKE is desired. S is a customization byte string used for domain
		separation. When N and S are both empty, this is equivalent to NewSHAKE256.


	
		NewSHAKE128 creates a new SHAKE128 XOF.


	
		NewSHAKE256 creates a new SHAKE256 XOF.


	
		Sum224 returns the SHA3-224 hash of data.


	
		Sum256 returns the SHA3-256 hash of data.


	
		Sum384 returns the SHA3-384 hash of data.


	
		Sum512 returns the SHA3-512 hash of data.


	
		SumSHAKE128 applies the SHAKE128 extendable output function to data and
		returns an output of the given length in bytes.


	
		SumSHAKE256 applies the SHAKE256 extendable output function to data and
		returns an output of the given length in bytes.