package sha1

Import Path
	crypto/sha1 (on go.dev)

Dependency Relation
	imports 7 packages, and imported by 5 packages

Involved Source Files

	    boring.go
	  d sha1.go
		Package sha1 implements the SHA-1 hash algorithm as defined in RFC 3174.
		
		SHA-1 is cryptographically broken and should not be used for secure
		applications.

	    sha1block.go
	    sha1block_amd64.go
	    sha1block_amd64.s
Code Examples

	New
		package main
		
		import (
			"crypto/sha1"
			"fmt"
			"io"
		)
		
		func main() {
			h := sha1.New()
			io.WriteString(h, "His money is twice tainted:")
			io.WriteString(h, " 'taint yours and 'taint mine.")
			fmt.Printf("% x", h.Sum(nil))
		}

	New_file
		package main
		
		import (
			"crypto/sha1"
			"fmt"
			"io"
			"log"
			"os"
		)
		
		func main() {
			f, err := os.Open("file.txt")
			if err != nil {
				log.Fatal(err)
			}
			defer f.Close()
		
			h := sha1.New()
			if _, err := io.Copy(h, f); err != nil {
				log.Fatal(err)
			}
		
			fmt.Printf("% x", h.Sum(nil))
		}

	Sum
		package main
		
		import (
			"crypto/sha1"
			"fmt"
		)
		
		func main() {
			data := []byte("This page intentionally left blank.")
			fmt.Printf("% x", sha1.Sum(data))
		}


Package-Level Type Names (only one, which is unexported)

	/* sort exporteds by: alphabet | popularity */
	/* one unexported ... *//* one unexported: */
	 type digest (struct)
		digest represents the partial evaluation of a checksum.

		Fields (total 4, none are exported)
			/* 4 unexporteds ... *//* 4 unexporteds: */
			h [5]uint32
			len uint64
			nx int
			x [64]byte
		Methods (total 10, in which 8 are exported)
			(*digest) BlockSize() int
			(*digest) ConstantTimeSum(in []byte) []byte
				ConstantTimeSum computes the same result of Sum() but in constant time

			(*digest) MarshalBinary() ([]byte, error)
			(*digest) Reset()
			(*digest) Size() int
			(*digest) Sum(in []byte) []byte
			(*digest) UnmarshalBinary(b []byte) error
			(*digest) Write(p []byte) (nn int, err error)
			/* 2 unexporteds ... *//* 2 unexporteds: */
			(*digest) checkSum() [20]byte
			(*digest) constSum() [20]byte
		Implements (at least 8, in which 5 are exported)
			*digest : encoding.BinaryMarshaler
			*digest : encoding.BinaryUnmarshaler
			*digest : hash.Hash
			*digest : internal/bisect.Writer
			*digest : io.Writer
			/* 3+ unexporteds ... *//* 3+ unexporteds: */
			*digest : crypto/hmac.marshalable
			*digest : crypto/tls.constantTimeHash
			*digest : crypto/tls.transcriptHash
		As Inputs Of (at least 4, none are exported)
			/* 4+ unexporteds ... *//* 4+ unexporteds: */
			func block(dig *digest, p []byte)
			func blockAMD64(dig *digest, p []byte)
			func blockAVX2(dig *digest, p []byte)
			func blockGeneric(dig *digest, p []byte)


Package-Level Functions (total 12, in which 2 are exported)

	 func New() hash.Hash
		New returns a new hash.Hash computing the SHA1 checksum. The Hash also
		implements encoding.BinaryMarshaler and encoding.BinaryUnmarshaler to
		marshal and unmarshal the internal state of the hash.

	 func Sum(data []byte) [20]byte
		Sum returns the SHA-1 checksum of the data.

	/* 10 unexporteds ... *//* 10 unexporteds: */
	 func block(dig *digest, p []byte)
	 func blockAMD64(dig *digest, p []byte)
	 func blockAVX2(dig *digest, p []byte)
	 func blockGeneric(dig *digest, p []byte)
		blockGeneric is a portable, pure Go version of the SHA-1 block step.
		It's used by sha1block_generic.go and tests.

	 func boringNewSHA1() hash.Hash
	 func boringSHA1(p []byte) [20]byte
	 func boringUnreachable()
	 func consumeUint32(b []byte) ([]byte, uint32)
	 func consumeUint64(b []byte) ([]byte, uint64)
	 func init()
Package-Level Variables (only one, which is unexported)

	/* one unexported ... *//* one unexported: */
	  var useAVX2 bool
Package-Level Constants (total 15, in which 2 are exported)

	const BlockSize = 64
		The blocksize of SHA-1 in bytes.

	const Size = 20
		The size of a SHA-1 checksum in bytes.

	/* 13 unexporteds ... *//* 13 unexporteds: */
	const _K0 = 1518500249
	const _K1 = 1859775393
	const _K2 = 2400959708
	const _K3 = 3395469782
	const boringEnabled = false
	const chunk = 64
	const init0 = 1732584193
	const init1 = 4023233417
	const init2 = 2562383102
	const init3 = 271733878
	const init4 = 3285377520
	const magic = "sha\x01"
	const marshaledSize int = 96

The pages are generated with Golds v0.6.7. (GOOS=linux GOARCH=amd64)
Golds is a Go 101 project developed by Tapir Liu.
PR and bug reports are welcome and can be submitted to the issue list.
Please follow @Go100and1 (reachable from the left QR code) to get the latest news of Golds.