File: hasher.go

package info (click to toggle)
golang-github-go-crypt-crypt 0.4.7-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 516 kB
  • sloc: makefile: 4
file content (70 lines) | stat: -rw-r--r-- 1,932 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
package plaintext

import (
	"github.com/go-crypt/crypt/algorithm"
)

// New returns a *plaintext.Hasher without any settings configured.
func New(opts ...Opt) (hasher *Hasher, err error) {
	hasher = &Hasher{}

	if err = hasher.WithOptions(opts...); err != nil {
		return nil, err
	}

	if err = hasher.Validate(); err != nil {
		return nil, err
	}

	return hasher, nil
}

// Hasher is a crypt.Hash for plaintext which can be initialized via plaintext.New using a functional options pattern.
type Hasher struct {
	variant Variant
}

// WithOptions applies the provided functional options provided as an plaintext.Opt to the plaintext.Hasher.
func (h *Hasher) WithOptions(opts ...Opt) (err error) {
	for _, opt := range opts {
		if err = opt(h); err != nil {
			return err
		}
	}

	return nil
}

// Validate checks the hasher configuration to ensure it's valid. This should be used when the plaintext.Hasher is going
// to be reused and you should use it in conjunction with MustHash.
func (h *Hasher) Validate() (err error) {
	return nil
}

// Hash performs the hashing operation on a password and resets any relevant parameters such as a manually set salt.
// It then returns a plaintext.Digest and error.
func (h *Hasher) Hash(password string) (hashed algorithm.Digest, err error) {
	d := &Digest{
		variant: h.variant,
		key:     []byte(password),
	}

	d.defaults()

	return d, nil
}

// HashWithSalt is an overload of plaintext.Digest that also accepts a salt.
func (h *Hasher) HashWithSalt(password string, _ []byte) (hashed algorithm.Digest, err error) {
	return h.Hash(password)
}

// MustHash overloads the Hash method and panics if the error is not nil. It's recommended if you use this method to
// utilize the Validate method first or handle the panic appropriately.
func (h *Hasher) MustHash(password string) (hashed algorithm.Digest) {
	if d, err := h.Hash(password); err != nil {
		panic(err)
	} else {
		return d
	}
}