From 8fdca881aa516c25422491e3dd873dd0f43a8f66 Mon Sep 17 00:00:00 2001 From: Matthew Hartstonge Date: Tue, 27 Apr 2021 15:07:46 +1200 Subject: [PATCH] :arrow_up: deps: migrate v3 to subfolder to comply to go mod standards. --- v3/go.mod | 10 +++++++ v3/go.sum | 58 +++++++++++++++++++++++++++++++++++++++ v3/hash_argon2.go | 52 +++++++++++++++++++++++++++++++++++ v3/hash_argon2_test.go | 62 ++++++++++++++++++++++++++++++++++++++++++ 4 files changed, 182 insertions(+) create mode 100644 v3/go.mod create mode 100644 v3/go.sum create mode 100644 v3/hash_argon2.go create mode 100644 v3/hash_argon2_test.go diff --git a/v3/go.mod b/v3/go.mod new file mode 100644 index 0000000..a6a3e9c --- /dev/null +++ b/v3/go.mod @@ -0,0 +1,10 @@ +module github.com/matthewhartstonge/hasher/v3 + +go 1.16 + +require ( + github.com/matthewhartstonge/argon2 v0.1.4 + github.com/ory/fosite v0.25.0 + github.com/pkg/errors v0.8.0 + github.com/stretchr/testify v1.2.2 +) diff --git a/v3/go.sum b/v3/go.sum new file mode 100644 index 0000000..9cf28ce --- /dev/null +++ b/v3/go.sum @@ -0,0 +1,58 @@ +github.com/asaskevich/govalidator v0.0.0-20180720115003-f9ffefc3facf h1:eg0MeVzsP1G42dRafH3vf+al2vQIJU0YHX+1Tw87oco= +github.com/asaskevich/govalidator v0.0.0-20180720115003-f9ffefc3facf/go.mod h1:lB+ZfQJz7igIIfQNfa7Ml4HSf2uFQQRzpGGRXenZAgY= +github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c= +github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= +github.com/dgrijalva/jwt-go v3.2.0+incompatible h1:7qlOGliEKZXTDg6OTjfoBKDXWrumCAMpl/TFQ4/5kLM= +github.com/dgrijalva/jwt-go v3.2.0+incompatible/go.mod h1:E3ru+11k8xSBh+hMPgOLZmtrrCbhqsmaPHjLKYnJCaQ= +github.com/elazarl/goproxy v0.0.0-20181003060214-f58a169a71a5/go.mod h1:/Zj4wYkgs4iZTTu3o/KG3Itv/qCCa8VVMlb3i9OVuzc= +github.com/golang/mock v1.1.1 h1:G5FRp8JnTd7RQH5kemVNlMeyXQAztQ3mOWV95KxsXH8= +github.com/golang/mock v1.1.1/go.mod h1:oTYuIxOrZwtPieC+H1uAHpcLFnEyAGVDL/k47Jfbm0A= +github.com/golang/protobuf v1.2.0/go.mod h1:6lQm79b+lXiMfvg/cZm0SGofjICqVBUtrP5yJMmIC1U= +github.com/google/uuid v1.0.0 h1:b4Gk+7WdP/d3HZH8EJsZpvV7EtDOgaZLtnaNGIu1adA= +github.com/google/uuid v1.0.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo= +github.com/gopherjs/gopherjs v0.0.0-20181004151105-1babbf986f6f/go.mod h1:wJfORRmW1u3UXTncJ5qlYoELFm8eSnnEO6hX4iZ3EWY= +github.com/gorilla/context v1.1.1/go.mod h1:kBGZzfjB9CEq2AlWe17Uuf7NDRt0dE0s8S51q0aT7Yg= +github.com/gorilla/mux v1.6.2/go.mod h1:1lud6UwP+6orDFRuTfBEV8e9/aOM/c4fVVCaMa2zaAs= +github.com/gtank/cryptopasta v0.0.0-20170601214702-1f550f6f2f69 h1:7xsUJsB2NrdcttQPa7JLEaGzvdbk7KvfrjgHZXOQRo0= +github.com/gtank/cryptopasta v0.0.0-20170601214702-1f550f6f2f69/go.mod h1:YLEMZOtU+AZ7dhN9T/IpGhXVGly2bvkJQ+zxj3WeVQo= +github.com/jtolds/gls v4.2.1+incompatible/go.mod h1:QJZ7F/aHp+rZTRtaJ1ow/lLfFfVYBRgL+9YlvaHOwJU= +github.com/magiconair/properties v1.8.0/go.mod h1:PppfXfuXeibc/6YijjN8zIbojt8czPbwD3XqdrwzmxQ= +github.com/matthewhartstonge/argon2 v0.1.4 h1:XalXB/BERpIZbOHV/31FYFFQxsl6GTrTq2N10rwfNGc= +github.com/matthewhartstonge/argon2 v0.1.4/go.mod h1:ZOSVMa24Ro9NpCjIobiwO49tymOSJ8ZaUmbcdrbrhYQ= +github.com/mohae/deepcopy v0.0.0-20170929034955-c48cc78d4826 h1:RWengNIwukTxcDr9M+97sNutRR1RKhG96O6jWumTTnw= +github.com/mohae/deepcopy v0.0.0-20170929034955-c48cc78d4826/go.mod h1:TaXosZuwdSHYgviHp1DAtfrULt5eUgsSMsZf+YrPgl8= +github.com/moul/http2curl v0.0.0-20170919181001-9ac6cf4d929b/go.mod h1:8UbvGypXm98wA/IqH45anm5Y2Z6ep6O31QGOAZ3H0fQ= +github.com/oleiade/reflections v1.0.0 h1:0ir4pc6v8/PJ0yw5AEtMddfXpWBXg9cnG7SgSoJuCgY= +github.com/oleiade/reflections v1.0.0/go.mod h1:RbATFBbKYkVdqmSFtx13Bb/tVhR0lgOBXunWTZKeL4w= +github.com/ory/fosite v0.25.0 h1:GELSEQc6OIDsfvtx1nC0snzPpFF14W/f6MeMXPEiZ9I= +github.com/ory/fosite v0.25.0/go.mod h1:uttCRNB0lM7+BJFX7CC8Bqo9gAPrcpmA9Ezc80Trwuw= +github.com/ory/go-convenience v0.1.0 h1:zouLKfF2GoSGnJwGq+PE/nJAE6dj2Zj5QlTgmMTsTS8= +github.com/ory/go-convenience v0.1.0/go.mod h1:uEY/a60PL5c12nYz4V5cHY03IBmwIAEm8TWB0yn9KNs= +github.com/parnurzeal/gorequest v0.2.15/go.mod h1:3Kh2QUMJoqw3icWAecsyzkpY7UzRfDhbRdTjtNwNiUE= +github.com/pborman/uuid v1.2.0 h1:J7Q5mO4ysT1dv8hyrUGHb9+ooztCXu1D8MY8DZYsu3g= +github.com/pborman/uuid v1.2.0/go.mod h1:X/NO0urCmaxf9VXbdlT7C2Yzkj2IKimNn4k+gtPdI/k= +github.com/pkg/errors v0.8.0 h1:WdK/asTD0HN+q6hsWO3/vpuAkAr+tw6aNJNDFFf0+qw= +github.com/pkg/errors v0.8.0/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINEl0= +github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM= +github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4= +github.com/smartystreets/assertions v0.0.0-20180927180507-b2de0cb4f26d/go.mod h1:OnSkiWE9lh6wB0YB77sQom3nweQdgAjqCqsofrRNTgc= +github.com/smartystreets/goconvey v0.0.0-20180222194500-ef6db91d284a/go.mod h1:XDJAKZRPZ1CvBcN2aX5YOUTYGHki24fSF0Iv48Ibg0s= +github.com/stretchr/testify v1.2.2 h1:bSDNvY7ZPG5RlJ8otE/7V6gMiyenm9RtJ7IUVIAoJ1w= +github.com/stretchr/testify v1.2.2/go.mod h1:a8OnRcib4nhh0OaRAV+Yts87kKdq0PP7pXfy6kDkUVs= +golang.org/x/crypto v0.0.0-20181001203147-e3636079e1a4/go.mod h1:6SG95UA2DQfeDnfUPMdvaQW0Q7yPrPDi9nlGo2tz2b4= +golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w= +golang.org/x/crypto v0.0.0-20200510223506-06a226fb4e37 h1:cg5LA/zNPRzIXIWSCxQW10Rvpy94aQh3LT/ShoCpkHw= +golang.org/x/crypto v0.0.0-20200510223506-06a226fb4e37/go.mod h1:LzIPMQfyMNhhGPhUkYOs5KpL4U8rLKemX1yGLhDgUto= +golang.org/x/net v0.0.0-20180724234803-3673e40ba225/go.mod h1:mL1N/T3taQHkDXs73rZJwtUhF3w3ftmwwsq0BUmARs4= +golang.org/x/net v0.0.0-20181005035420-146acd28ed58/go.mod h1:mL1N/T3taQHkDXs73rZJwtUhF3w3ftmwwsq0BUmARs4= +golang.org/x/net v0.0.0-20190404232315-eb5bcb51f2a3 h1:0GoQqolDA55aaLxZyTzK/Y2ePZzZTUrRacwib7cNsYQ= +golang.org/x/net v0.0.0-20190404232315-eb5bcb51f2a3/go.mod h1:t9HGtf8HONx5eT2rtn7q6eTqICYqUVnKs3thJo3Qplg= +golang.org/x/oauth2 v0.0.0-20181003184128-c57b0facaced/go.mod h1:N/0e6XlmueqKjAGxoOufVs8QHGRruUQn6yWY3a++T0U= +golang.org/x/sync v0.0.0-20180314180146-1d60e4601c6f/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= +golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY= +golang.org/x/sys v0.0.0-20190412213103-97732733099d h1:+R4KGOnez64A81RvjARKc4UT5/tI9ujCIVX+P5KiHuI= +golang.org/x/sys v0.0.0-20190412213103-97732733099d/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ= +google.golang.org/appengine v1.2.0/go.mod h1:xpcJRLb0r/rnEns0DIKYYv+WjYCduHsrkT7/EB5XEv4= +gopkg.in/square/go-jose.v2 v2.1.9 h1:YCFbL5T2gbmC2sMG12s1x2PAlTK5TZNte3hjZEIcCAg= +gopkg.in/square/go-jose.v2 v2.1.9/go.mod h1:M9dMgbHiYLoDGQrXy7OpJDJWiKiU//h+vD76mk0e1AI= diff --git a/v3/hash_argon2.go b/v3/hash_argon2.go new file mode 100644 index 0000000..dea763c --- /dev/null +++ b/v3/hash_argon2.go @@ -0,0 +1,52 @@ +package hasher + +import ( + // Standard Library Imports + "context" + + // External Imports + "github.com/matthewhartstonge/argon2" + "github.com/ory/fosite" + "github.com/pkg/errors" +) + +// Argon2 implements fosite.Hasher. +type Argon2 struct { + Config argon2.Config +} + +// Compare compares data with an Argon2 hash and returns an error +// if the two do not match. +func (a *Argon2) Compare(ctx context.Context, hash, data []byte) error { + ok, err := argon2.VerifyEncoded(data, hash) + if err != nil { + return errors.WithStack(err) + } + if !ok { + return fosite.ErrRequestUnauthorized + } + return nil +} + +// Hash creates a Argon2 hash from data or returns an error. +// The salt is automatically generated based on the length of the Salt as specified by Config.SaltLength +func (a *Argon2) Hash(ctx context.Context, data []byte) ([]byte, error) { + s, err := a.Config.HashEncoded(data) + if err != nil { + return nil, errors.WithStack(err) + } + return s, nil +} + +// New instantiates a new Argon 2 Hasher. +// Implements fosite.Hasher. +func New(config *argon2.Config) *Argon2 { + cfg := argon2.DefaultConfig() + if config != nil { + cfg = *config + } + + return &Argon2{ + Config: cfg, + } +} diff --git a/v3/hash_argon2_test.go b/v3/hash_argon2_test.go new file mode 100644 index 0000000..867ab81 --- /dev/null +++ b/v3/hash_argon2_test.go @@ -0,0 +1,62 @@ +package hasher_test + +import ( + // Standard Library Imports + "context" + "testing" + + // External Imports + "github.com/matthewhartstonge/argon2" + "github.com/ory/fosite" + "github.com/stretchr/testify/assert" + + // Internal Imports + "github.com/matthewhartstonge/hasher/v3" +) + +// TestArgon2_ImplementsHasher ensures that Argon2 implements the fosite.Hasher +// interface. +func TestArgon2_ImplementsHasher(t *testing.T) { + v := &hasher.Argon2{} + var i interface{} = v + _, ok := i.(fosite.Hasher) + assert.Equal(t, true, ok) +} + +// TestArgon2Hash ensures that a hash is returned from the Argon2 Hasher +func TestArgon2Hash(t *testing.T) { + h := &hasher.Argon2{ + Config: argon2.DefaultConfig(), + } + password := []byte("foo") + hash, err := h.Hash(context.Background(), password) + assert.Nil(t, err) + assert.NotNil(t, hash) + assert.NotEqual(t, hash, password) +} + +// TestArgon2CompareEquals ensures a password can be verified successfully when decoded +func TestArgon2CompareEquals(t *testing.T) { + h := &hasher.Argon2{ + Config: argon2.DefaultConfig(), + } + password := []byte("foo") + hash, err := h.Hash(context.Background(), password) + assert.Nil(t, err) + assert.NotNil(t, hash) + err = h.Compare(context.Background(), hash, password) + assert.Nil(t, err) +} + +// TestArgon2CompareEquals ensures a compare errors when a presented clear text password does not match the original +func TestArgon2CompareDifferent(t *testing.T) { + h := &hasher.Argon2{ + Config: argon2.DefaultConfig(), + } + password := []byte("foo") + hash, err := h.Hash(context.Background(), password) + assert.Nil(t, err) + assert.NotNil(t, hash) + err = h.Compare(context.Background(), hash, []byte("911650fc-df29-4622-8c6f-f43cbacd1ece")) + assert.NotNil(t, err) +}