From 7890a7d7cf40f8f951ba15227125c9c673dbb35b Mon Sep 17 00:00:00 2001 From: Nathaniel Cook Date: Mon, 18 Jul 2016 11:31:45 -0600 Subject: [PATCH] Initial auth plumbing (#702) * auth plumbing * git subrepo clone --branch=v3.0.0 https://github.com/dgrijalva/jwt-go.git vendor/github.com/dgrijalva/jwt-go subrepo: subdir: "vendor/github.com/dgrijalva/jwt-go" merged: "d2709f9" upstream: origin: "https://github.com/dgrijalva/jwt-go.git" branch: "v3.0.0" commit: "d2709f9" git-subrepo: version: "0.3.0" origin: "???" commit: "???" * update license deps and changelog * refactor to simpler privilege model * CHANGELOG.md * hide wlog in logging service * make overriding services easier --- CHANGELOG.md | 2 + LICENSE_OF_DEPENDENCIES.md | 1 + auth/auth.go | 166 ++++++ auth/auth_test.go | 479 ++++++++++++++++++ client/v1/client.go | 156 ++++-- client/v1/client_test.go | 113 ++++- integrations/benchmark_test.go | 3 +- integrations/helpers_test.go | 9 +- server/server.go | 338 +++++++----- server/server_helper_test.go | 9 +- server/server_test.go | 161 +++++- services/httpd/config.go | 1 + services/httpd/handler.go | 270 ++++++++-- services/httpd/handler_test.go | 100 ++++ services/httpd/service.go | 1 + services/logging/service.go | 25 +- services/noauth/service.go | 39 ++ vendor.list | 1 + vendor/github.com/dgrijalva/jwt-go/.gitignore | 4 + vendor/github.com/dgrijalva/jwt-go/.gitrepo | 11 + .../github.com/dgrijalva/jwt-go/.travis.yml | 8 + vendor/github.com/dgrijalva/jwt-go/LICENSE | 8 + .../dgrijalva/jwt-go/MIGRATION_GUIDE.md | 96 ++++ vendor/github.com/dgrijalva/jwt-go/README.md | 85 ++++ .../dgrijalva/jwt-go/VERSION_HISTORY.md | 105 ++++ vendor/github.com/dgrijalva/jwt-go/claims.go | 134 +++++ .../dgrijalva/jwt-go/cmd/jwt/README.md | 13 + .../dgrijalva/jwt-go/cmd/jwt/app.go | 245 +++++++++ vendor/github.com/dgrijalva/jwt-go/doc.go | 4 + vendor/github.com/dgrijalva/jwt-go/ecdsa.go | 147 ++++++ .../github.com/dgrijalva/jwt-go/ecdsa_test.go | 100 ++++ .../dgrijalva/jwt-go/ecdsa_utils.go | 67 +++ vendor/github.com/dgrijalva/jwt-go/errors.go | 63 +++ .../dgrijalva/jwt-go/example_test.go | 114 +++++ vendor/github.com/dgrijalva/jwt-go/hmac.go | 94 ++++ .../dgrijalva/jwt-go/hmac_example_test.go | 64 +++ .../github.com/dgrijalva/jwt-go/hmac_test.go | 91 ++++ .../dgrijalva/jwt-go/http_example_test.go | 216 ++++++++ .../github.com/dgrijalva/jwt-go/map_claims.go | 94 ++++ vendor/github.com/dgrijalva/jwt-go/none.go | 52 ++ .../github.com/dgrijalva/jwt-go/none_test.go | 72 +++ vendor/github.com/dgrijalva/jwt-go/parser.go | 128 +++++ .../dgrijalva/jwt-go/parser_test.go | 252 +++++++++ .../dgrijalva/jwt-go/request/doc.go | 7 + .../dgrijalva/jwt-go/request/extractor.go | 81 +++ .../jwt-go/request/extractor_example_test.go | 32 ++ .../jwt-go/request/extractor_test.go | 91 ++++ .../dgrijalva/jwt-go/request/oauth2.go | 28 + .../dgrijalva/jwt-go/request/request.go | 24 + .../dgrijalva/jwt-go/request/request_test.go | 103 ++++ vendor/github.com/dgrijalva/jwt-go/rsa.go | 100 ++++ vendor/github.com/dgrijalva/jwt-go/rsa_pss.go | 126 +++++ .../dgrijalva/jwt-go/rsa_pss_test.go | 96 ++++ .../github.com/dgrijalva/jwt-go/rsa_test.go | 176 +++++++ .../github.com/dgrijalva/jwt-go/rsa_utils.go | 69 +++ .../dgrijalva/jwt-go/signing_method.go | 35 ++ .../dgrijalva/jwt-go/test/ec256-private.pem | 5 + .../dgrijalva/jwt-go/test/ec256-public.pem | 4 + .../dgrijalva/jwt-go/test/ec384-private.pem | 6 + .../dgrijalva/jwt-go/test/ec384-public.pem | 5 + .../dgrijalva/jwt-go/test/ec512-private.pem | 7 + .../dgrijalva/jwt-go/test/ec512-public.pem | 6 + .../dgrijalva/jwt-go/test/helpers.go | 42 ++ .../dgrijalva/jwt-go/test/hmacTestKey | 1 + .../dgrijalva/jwt-go/test/sample_key | 27 + .../dgrijalva/jwt-go/test/sample_key.pub | 9 + vendor/github.com/dgrijalva/jwt-go/token.go | 108 ++++ 67 files changed, 5089 insertions(+), 240 deletions(-) create mode 100644 auth/auth.go create mode 100644 auth/auth_test.go create mode 100644 services/httpd/handler_test.go create mode 100644 services/noauth/service.go create mode 100644 vendor/github.com/dgrijalva/jwt-go/.gitignore create mode 100644 vendor/github.com/dgrijalva/jwt-go/.gitrepo create mode 100644 vendor/github.com/dgrijalva/jwt-go/.travis.yml create mode 100644 vendor/github.com/dgrijalva/jwt-go/LICENSE create mode 100644 vendor/github.com/dgrijalva/jwt-go/MIGRATION_GUIDE.md create mode 100644 vendor/github.com/dgrijalva/jwt-go/README.md create mode 100644 vendor/github.com/dgrijalva/jwt-go/VERSION_HISTORY.md create mode 100644 vendor/github.com/dgrijalva/jwt-go/claims.go create mode 100644 vendor/github.com/dgrijalva/jwt-go/cmd/jwt/README.md create mode 100644 vendor/github.com/dgrijalva/jwt-go/cmd/jwt/app.go create mode 100644 vendor/github.com/dgrijalva/jwt-go/doc.go create mode 100644 vendor/github.com/dgrijalva/jwt-go/ecdsa.go create mode 100644 vendor/github.com/dgrijalva/jwt-go/ecdsa_test.go create mode 100644 vendor/github.com/dgrijalva/jwt-go/ecdsa_utils.go create mode 100644 vendor/github.com/dgrijalva/jwt-go/errors.go create mode 100644 vendor/github.com/dgrijalva/jwt-go/example_test.go create mode 100644 vendor/github.com/dgrijalva/jwt-go/hmac.go create mode 100644 vendor/github.com/dgrijalva/jwt-go/hmac_example_test.go create mode 100644 vendor/github.com/dgrijalva/jwt-go/hmac_test.go create mode 100644 vendor/github.com/dgrijalva/jwt-go/http_example_test.go create mode 100644 vendor/github.com/dgrijalva/jwt-go/map_claims.go create mode 100644 vendor/github.com/dgrijalva/jwt-go/none.go create mode 100644 vendor/github.com/dgrijalva/jwt-go/none_test.go create mode 100644 vendor/github.com/dgrijalva/jwt-go/parser.go create mode 100644 vendor/github.com/dgrijalva/jwt-go/parser_test.go create mode 100644 vendor/github.com/dgrijalva/jwt-go/request/doc.go create mode 100644 vendor/github.com/dgrijalva/jwt-go/request/extractor.go create mode 100644 vendor/github.com/dgrijalva/jwt-go/request/extractor_example_test.go create mode 100644 vendor/github.com/dgrijalva/jwt-go/request/extractor_test.go create mode 100644 vendor/github.com/dgrijalva/jwt-go/request/oauth2.go create mode 100644 vendor/github.com/dgrijalva/jwt-go/request/request.go create mode 100644 vendor/github.com/dgrijalva/jwt-go/request/request_test.go create mode 100644 vendor/github.com/dgrijalva/jwt-go/rsa.go create mode 100644 vendor/github.com/dgrijalva/jwt-go/rsa_pss.go create mode 100644 vendor/github.com/dgrijalva/jwt-go/rsa_pss_test.go create mode 100644 vendor/github.com/dgrijalva/jwt-go/rsa_test.go create mode 100644 vendor/github.com/dgrijalva/jwt-go/rsa_utils.go create mode 100644 vendor/github.com/dgrijalva/jwt-go/signing_method.go create mode 100644 vendor/github.com/dgrijalva/jwt-go/test/ec256-private.pem create mode 100644 vendor/github.com/dgrijalva/jwt-go/test/ec256-public.pem create mode 100644 vendor/github.com/dgrijalva/jwt-go/test/ec384-private.pem create mode 100644 vendor/github.com/dgrijalva/jwt-go/test/ec384-public.pem create mode 100644 vendor/github.com/dgrijalva/jwt-go/test/ec512-private.pem create mode 100644 vendor/github.com/dgrijalva/jwt-go/test/ec512-public.pem create mode 100644 vendor/github.com/dgrijalva/jwt-go/test/helpers.go create mode 100644 vendor/github.com/dgrijalva/jwt-go/test/hmacTestKey create mode 100644 vendor/github.com/dgrijalva/jwt-go/test/sample_key create mode 100644 vendor/github.com/dgrijalva/jwt-go/test/sample_key.pub create mode 100644 vendor/github.com/dgrijalva/jwt-go/token.go diff --git a/CHANGELOG.md b/CHANGELOG.md index afdb010a8..0908f7478 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -6,6 +6,8 @@ ### Features +- [#702](https://github.com/influxdata/kapacitor/pull/702): Add plumbing for authentication backends. + ### Bugfixes - [#710](https://github.com/influxdata/kapacitor/pull/710): Fix infinite loop when parsing unterminated regex in TICKscript. diff --git a/LICENSE_OF_DEPENDENCIES.md b/LICENSE_OF_DEPENDENCIES.md index fb494350c..00d72e901 100644 --- a/LICENSE_OF_DEPENDENCIES.md +++ b/LICENSE_OF_DEPENDENCIES.md @@ -4,6 +4,7 @@ Dependencies * github.com/boltdb/bolt [MIT](https://github.com/boltdb/bolt/blob/master/LICENSE) * github.com/BurntSushi/toml [WTFPL](https://github.com/BurntSushi/toml/blob/master/COPYING) * github.com/cenkalti/backoff [MIT](https://github.com/cenkalti/backoff/blob/master/LICENSE) +* github.com/dgrijalva/jwt-go [MIT](https://github.com/dgrijalva/jwt-go/blob/master/LICENSE) * github.com/dustin/go-humanize [MIT](https://github.com/dustin/go-humanize/blob/master/LICENSE) * github.com/golang/protobuf [BSD](https://github.com/golang/protobuf/blob/master/LICENSE) * github.com/gorhill/cronexpr [APLv2](https://github.com/gorhill/cronexpr/blob/master/APLv2) diff --git a/auth/auth.go b/auth/auth.go new file mode 100644 index 000000000..3cf2a6440 --- /dev/null +++ b/auth/auth.go @@ -0,0 +1,166 @@ +package auth + +import ( + "errors" + "fmt" + "path" +) + +// Interface for authenticating and retrieving users. +type Interface interface { + Authenticate(username, password string) (User, error) + User(username string) (User, error) +} + +// ErrAuthenticate is returned when authentication fails. +var ErrAuthenticate = errors.New("authentication failed") + +type Privilege uint + +const ( + NoPrivileges Privilege = 1 << iota + + ReadPrivilege + WritePrivilege + DeletePrivilege + + AllPrivileges +) + +var PrivilegeList []Privilege + +func init() { + p := Privilege(0) + for i := uint(0); p < AllPrivileges; i++ { + p = 1 << i + PrivilegeList = append(PrivilegeList, p) + } +} + +func (p Privilege) String() string { + switch p { + case NoPrivileges: + return "none" + case ReadPrivilege: + return "read" + case WritePrivilege: + return "write" + case DeletePrivilege: + return "delete" + case AllPrivileges: + return "all" + default: + return "unknown" + } +} + +type Action struct { + Resource string + Privilege Privilege +} + +// This structure is designed to be immutable, to avoid bugs/exploits where +// the user could be modified by external code. +// For this reason all fields are private and methods are value receivers. +type User struct { + name string + admin bool + hash []byte + // Map of resource -> Bitmask of Privileges + privileges map[string]Privilege +} + +// Create a user with the given privileges. +func NewUser(name string, hash []byte, admin bool, privileges map[string][]Privilege) User { + ps := make(map[string]Privilege, len(privileges)) + // Clean resources and convert to bitmask + for resource, privileges := range privileges { + clean := path.Clean(resource) + mask := Privilege(0) + for _, p := range privileges { + mask |= p + } + ps[clean] = mask + } + // Make our own copy of the hash + h := make([]byte, len(hash)) + copy(h, hash) + return User{ + name: name, + admin: admin, + hash: h, + privileges: ps, + } +} + +// This user has all privileges for all resources. +var AdminUser = NewUser("ADMIN_USER", nil, true, nil) + +// Determine wether the user is authorized to take the action. +func (u User) Name() string { + return u.name +} + +// Report whether the user is an Admin user +func (u User) IsAdmin() bool { + return u.admin +} + +// Return a copy of the user's password hash +func (u User) Hash() []byte { + hash := make([]byte, len(u.hash)) + copy(hash, u.hash) + return hash +} + +// Return a copy of the privileges the user has. +func (u User) Privileges() map[string][]Privilege { + privileges := make(map[string][]Privilege) + for r, ps := range u.privileges { + for _, p := range PrivilegeList { + if ps&p != 0 { + privileges[r] = append(privileges[r], p) + } + } + } + return privileges +} + +// Determine wether the user is authorized to take the action. +// Returns nil if the action is authorized, otherwise returns an error describing the needed permissions. +func (u User) AuthorizeAction(action Action) error { + if action.Privilege == NoPrivileges || u.admin { + return nil + } + // Find a matching resource of the form /path/to/resource + // where if the resource is /a/b/c and the user has permision to /a/b + // then it is considered valid. + if !path.IsAbs(action.Resource) { + return fmt.Errorf("invalid action resource: %q, must be an absolute path", action.Resource) + } + if len(u.privileges) > 0 { + // Clean path to prevent path traversal like /a/b/../d when user has access to /a/b + resource := path.Clean(action.Resource) + for { + if p, ok := u.privileges[resource]; ok { + // Found matching resource + authorized := p&action.Privilege != 0 || p == AllPrivileges + if authorized { + return nil + } else { + break + } + } + if resource == "/" { + break + } + // Pop off the last piece of the resource and try again + resource = path.Dir(resource) + } + } + return fmt.Errorf("user %s does not have \"%v\" privilege for resource %q", u.name, action.Privilege, action.Resource) +} + +func DatabaseResource(database string) string { + return "/databases/" + database +} diff --git a/auth/auth_test.go b/auth/auth_test.go new file mode 100644 index 000000000..6bb678506 --- /dev/null +++ b/auth/auth_test.go @@ -0,0 +1,479 @@ +package auth_test + +import ( + "errors" + "testing" + + "github.com/influxdata/kapacitor/auth" +) + +func Test_Privilege_String(t *testing.T) { + testCases := []struct { + p auth.Privilege + s string + }{ + { + p: auth.NoPrivileges, + s: "none", + }, + { + p: auth.ReadPrivilege, + s: "read", + }, + { + p: auth.WritePrivilege, + s: "write", + }, + { + p: auth.DeletePrivilege, + s: "delete", + }, + { + p: auth.AllPrivileges, + s: "all", + }, + { + p: auth.AllPrivileges + 1, + s: "unknown", + }, + } + + for _, tc := range testCases { + if exp, got := tc.s, tc.p.String(); exp != got { + t.Errorf("unexpected string value: got %s exp %s", got, exp) + } + } +} + +func Test_NewUser(t *testing.T) { + privs := map[string][]auth.Privilege{ + "/simple/path/": []auth.Privilege{auth.ReadPrivilege, auth.WritePrivilege}, + "/../messy/./path": []auth.Privilege{auth.DeletePrivilege, auth.WritePrivilege}, + "/another/path/and/some/more": []auth.Privilege{auth.AllPrivileges}, + "/blocked/path": []auth.Privilege{auth.NoPrivileges}, + } + hash := []byte("hash") + u := auth.NewUser("username", hash, false, privs) + + if exp, got := "username", u.Name(); got != exp { + t.Errorf("unexpected username: got %s exp %s", got, exp) + } + if exp, got := false, u.IsAdmin(); got != exp { + t.Errorf("unexpected admin: got %t exp %t", got, exp) + } + + // Manipulate hash to test user has its own copy + hash[0] = 'b' + if exp, got := "hash", string(u.Hash()); got != exp { + t.Errorf("unexpected hash: got %s exp %s", got, exp) + } + + // Manipulate privileges to test user has its own copy + privs["/blocked/path"] = []auth.Privilege{auth.AllPrivileges} + + expPrivileges := map[string][]auth.Privilege{ + "/simple/path": []auth.Privilege{auth.ReadPrivilege, auth.WritePrivilege}, + "/messy/path": []auth.Privilege{auth.DeletePrivilege, auth.WritePrivilege}, + "/another/path/and/some/more": []auth.Privilege{auth.AllPrivileges}, + "/blocked/path": []auth.Privilege{auth.NoPrivileges}, + } + gotPrivileges := u.Privileges() + if got, exp := len(gotPrivileges), len(expPrivileges); got != exp { + t.Errorf("unexpected privileges count: got %d exp %d", got, exp) + } + for r, expPs := range expPrivileges { + gotPs, ok := gotPrivileges[r] + if !ok { + t.Errorf("missing privilege: %s", r) + continue + } + if got, exp := len(gotPs), len(expPs); got != exp { + t.Errorf("unexpected privileges list count for resource %s: got %d exp %d", r, got, exp) + } + + for _, ep := range expPs { + found := false + for _, gp := range gotPs { + if ep == gp { + found = true + break + } + } + if !found { + t.Errorf("missing privilege %v from list for resource %s", ep, r) + } + } + } + + a := auth.NewUser("admin", nil, true, nil) + if exp, got := "admin", a.Name(); got != exp { + t.Errorf("unexpected username: got %s exp %s", got, exp) + } + if exp, got := true, a.IsAdmin(); got != exp { + t.Errorf("unexpected admin: got %t exp %t", got, exp) + } +} + +func Test_User_AuthorizeAction(t *testing.T) { + testCases := []struct { + username string + admin bool + privileges map[string][]auth.Privilege + action auth.Action + authorized bool + err error + }{ + { + username: "bob", + privileges: map[string][]auth.Privilege{ + "/a/b/c": []auth.Privilege{auth.WritePrivilege}, + }, + action: auth.Action{ + Resource: "/a/b/c", + Privilege: auth.WritePrivilege, + }, + authorized: true, + err: nil, + }, + { + username: "jim", + privileges: map[string][]auth.Privilege{ + "/a/b/": []auth.Privilege{auth.WritePrivilege}, + }, + action: auth.Action{ + Resource: "/a/b/c", + Privilege: auth.WritePrivilege, + }, + authorized: true, + err: nil, + }, + { + username: "sue", + privileges: map[string][]auth.Privilege{ + "/a/b": []auth.Privilege{auth.WritePrivilege}, + }, + action: auth.Action{ + Resource: "/a/b/c", + Privilege: auth.WritePrivilege, + }, + authorized: true, + err: nil, + }, + { + username: "sue", + privileges: map[string][]auth.Privilege{ + "/b": []auth.Privilege{auth.WritePrivilege}, + "/c": []auth.Privilege{auth.WritePrivilege}, + "/d": []auth.Privilege{auth.WritePrivilege}, + "/a": []auth.Privilege{auth.WritePrivilege}, + }, + action: auth.Action{ + Resource: "/a/b/c", + Privilege: auth.WritePrivilege, + }, + authorized: true, + err: nil, + }, + { + username: "sally", + privileges: map[string][]auth.Privilege{ + "/a/": []auth.Privilege{auth.WritePrivilege}, + }, + action: auth.Action{ + Resource: "/a/b/c", + Privilege: auth.WritePrivilege, + }, + authorized: true, + err: nil, + }, + { + username: "alice", + privileges: map[string][]auth.Privilege{ + "/": []auth.Privilege{auth.WritePrivilege}, + }, + action: auth.Action{ + Resource: "/a/b/c", + Privilege: auth.WritePrivilege, + }, + authorized: true, + err: nil, + }, + { + username: "nick", + privileges: map[string][]auth.Privilege{ + "/c/": []auth.Privilege{auth.WritePrivilege}, + }, + action: auth.Action{ + Resource: "/a/b/c", + Privilege: auth.WritePrivilege, + }, + authorized: false, + err: errors.New(`user nick does not have "write" privilege for resource "/a/b/c"`), + }, + { + username: "annie", + privileges: map[string][]auth.Privilege{ + "/a/b/c/": []auth.Privilege{auth.WritePrivilege}, + }, + action: auth.Action{ + Resource: "/a/b/c", + Privilege: auth.WritePrivilege, + }, + authorized: true, + err: nil, + }, + { + username: "fred", + privileges: map[string][]auth.Privilege{ + "/a/b/c": []auth.Privilege{auth.ReadPrivilege}, + }, + action: auth.Action{ + Resource: "/a/b/c", + Privilege: auth.WritePrivilege, + }, + authorized: false, + err: errors.New(`user fred does not have "write" privilege for resource "/a/b/c"`), + }, + { + username: "phillip", + privileges: map[string][]auth.Privilege{ + "/a/b/c": []auth.Privilege{auth.ReadPrivilege}, + }, + action: auth.Action{ + Resource: "a/b/c", + Privilege: auth.WritePrivilege, + }, + authorized: false, + err: errors.New(`invalid action resource: "a/b/c", must be an absolute path`), + }, + { + username: "amy", + privileges: map[string][]auth.Privilege{ + "/": []auth.Privilege{auth.WritePrivilege, auth.ReadPrivilege}, + }, + action: auth.Action{ + Resource: "/a/b/c", + Privilege: auth.WritePrivilege, + }, + authorized: true, + err: nil, + }, + { + username: "andy", + privileges: map[string][]auth.Privilege{ + "/": []auth.Privilege{auth.WritePrivilege, auth.ReadPrivilege, auth.DeletePrivilege}, + }, + action: auth.Action{ + Resource: "/a/b/c", + Privilege: auth.WritePrivilege, + }, + authorized: true, + err: nil, + }, + { + username: "nicole", + privileges: map[string][]auth.Privilege{ + "/": []auth.Privilege{auth.WritePrivilege, auth.DeletePrivilege}, + }, + action: auth.Action{ + Resource: "/a/b/c", + Privilege: auth.WritePrivilege, + }, + authorized: true, + err: nil, + }, + { + username: "nathan", + privileges: map[string][]auth.Privilege{ + "/": []auth.Privilege{auth.AllPrivileges}, + }, + action: auth.Action{ + Resource: "/a/b/c", + Privilege: auth.WritePrivilege, + }, + authorized: true, + err: nil, + }, + { + username: "natalie", + privileges: map[string][]auth.Privilege{ + "/": []auth.Privilege{auth.ReadPrivilege, auth.DeletePrivilege}, + }, + action: auth.Action{ + Resource: "/a/b/c", + Privilege: auth.WritePrivilege, + }, + authorized: false, + err: errors.New(`user natalie does not have "write" privilege for resource "/a/b/c"`), + }, + { + username: "katherine", + privileges: map[string][]auth.Privilege{ + "/": []auth.Privilege{auth.NoPrivileges}, + }, + action: auth.Action{ + Resource: "/a/b/c", + Privilege: auth.WritePrivilege, + }, + authorized: false, + err: errors.New(`user katherine does not have "write" privilege for resource "/a/b/c"`), + }, + { + username: "cleverbob", + privileges: map[string][]auth.Privilege{ + "/a/d/e/f": []auth.Privilege{auth.ReadPrivilege}, + }, + action: auth.Action{ + Resource: "/a/b/c/../../d/e/f", + Privilege: auth.ReadPrivilege, + }, + authorized: true, + err: nil, + }, + { + username: "hackerbob", + privileges: map[string][]auth.Privilege{ + "/a/b": []auth.Privilege{auth.WritePrivilege}, + }, + action: auth.Action{ + Resource: "/a/b/c/../../d/e/f", + Privilege: auth.WritePrivilege, + }, + authorized: false, + err: errors.New(`user hackerbob does not have "write" privilege for resource "/a/b/c/../../d/e/f"`), + }, + { + username: "hackerjim", + privileges: map[string][]auth.Privilege{ + "/a/b": []auth.Privilege{auth.WritePrivilege}, + }, + action: auth.Action{ + Resource: "/a/b/c/../../../../d/e/f", + Privilege: auth.WritePrivilege, + }, + authorized: false, + err: errors.New(`user hackerjim does not have "write" privilege for resource "/a/b/c/../../../../d/e/f"`), + }, + { + username: "admin", + admin: true, + action: auth.Action{ + Resource: "/a/b/c", + Privilege: auth.WritePrivilege, + }, + authorized: true, + err: nil, + }, + { + username: "susan", + privileges: map[string][]auth.Privilege{ + "/": []auth.Privilege{auth.WritePrivilege, auth.ReadPrivilege, auth.DeletePrivilege}, + }, + action: auth.Action{ + Resource: "/a/b/c", + Privilege: auth.ReadPrivilege, + }, + authorized: true, + err: nil, + }, + { + username: "ellie", + privileges: map[string][]auth.Privilege{ + "/": []auth.Privilege{auth.WritePrivilege, auth.DeletePrivilege}, + }, + action: auth.Action{ + Resource: "/a/b/c", + Privilege: auth.ReadPrivilege, + }, + authorized: false, + err: errors.New(`user ellie does not have "read" privilege for resource "/a/b/c"`), + }, + { + username: "spencer", + privileges: map[string][]auth.Privilege{ + "/": []auth.Privilege{auth.ReadPrivilege, auth.DeletePrivilege}, + }, + action: auth.Action{ + Resource: "/a/b/c", + Privilege: auth.ReadPrivilege, + }, + authorized: true, + err: nil, + }, + { + username: "alexander", + privileges: map[string][]auth.Privilege{ + "/": []auth.Privilege{auth.AllPrivileges}, + }, + action: auth.Action{ + Resource: "/a/b/c", + Privilege: auth.WritePrivilege, + }, + authorized: true, + err: nil, + }, + { + username: "slim", + privileges: map[string][]auth.Privilege{ + "/": []auth.Privilege{auth.WritePrivilege, auth.ReadPrivilege, auth.DeletePrivilege}, + }, + action: auth.Action{ + Resource: "/a/b/c", + Privilege: auth.DeletePrivilege, + }, + authorized: true, + err: nil, + }, + { + username: "joel", + privileges: map[string][]auth.Privilege{ + "/": []auth.Privilege{auth.WritePrivilege, auth.ReadPrivilege}, + }, + action: auth.Action{ + Resource: "/a/b/c", + Privilege: auth.DeletePrivilege, + }, + authorized: false, + err: errors.New(`user joel does not have "delete" privilege for resource "/a/b/c"`), + }, + { + username: "sky", + privileges: map[string][]auth.Privilege{ + "/": []auth.Privilege{auth.ReadPrivilege, auth.DeletePrivilege}, + }, + action: auth.Action{ + Resource: "/a/b/c", + Privilege: auth.DeletePrivilege, + }, + authorized: true, + err: nil, + }, + { + username: "alex", + privileges: map[string][]auth.Privilege{ + "/": []auth.Privilege{auth.AllPrivileges}, + }, + action: auth.Action{ + Resource: "/a/b/c", + Privilege: auth.DeletePrivilege, + }, + authorized: true, + err: nil, + }, + } + for _, tc := range testCases { + u := auth.NewUser(tc.username, nil, tc.admin, tc.privileges) + err := u.AuthorizeAction(tc.action) + if err != nil { + if tc.err == nil { + t.Errorf("%s: unexpected error authorizing action: got %q", tc.username, err.Error()) + } else if err.Error() != tc.err.Error() { + t.Errorf("%s: unexpected error message: got %q exp %q", tc.username, err.Error(), tc.err.Error()) + } + } else { + if tc.err != nil { + t.Errorf("%s: AUTH BREACH: expected error authorizing action: %q", tc.username, tc.err.Error()) + } + } + } +} diff --git a/client/v1/client.go b/client/v1/client.go index eb08bf788..414640409 100644 --- a/client/v1/client.go +++ b/client/v1/client.go @@ -25,19 +25,21 @@ const DefaultUserAgent = "KapacitorClient" // The only exception is if you only have an ID for a resource // then use the appropriate *Link methods. -const basePath = "/kapacitor/v1" -const pingPath = basePath + "/ping" -const logLevelPath = basePath + "/loglevel" -const debugVarsPath = basePath + "/debug/vars" -const tasksPath = basePath + "/tasks" -const templatesPath = basePath + "/templates" -const recordingsPath = basePath + "/recordings" -const recordStreamPath = basePath + "/recordings/stream" -const recordBatchPath = basePath + "/recordings/batch" -const recordQueryPath = basePath + "/recordings/query" -const replaysPath = basePath + "/replays" -const replayBatchPath = basePath + "/replays/batch" -const replayQueryPath = basePath + "/replays/query" +const ( + basePath = "/kapacitor/v1" + pingPath = basePath + "/ping" + logLevelPath = basePath + "/loglevel" + debugVarsPath = basePath + "/debug/vars" + tasksPath = basePath + "/tasks" + templatesPath = basePath + "/templates" + recordingsPath = basePath + "/recordings" + recordStreamPath = basePath + "/recordings/stream" + recordBatchPath = basePath + "/recordings/batch" + recordQueryPath = basePath + "/recordings/query" + replaysPath = basePath + "/replays" + replayBatchPath = basePath + "/replays/batch" + replayQueryPath = basePath + "/replays/query" +) // HTTP configuration for connecting to Kapacitor type Config struct { @@ -57,13 +59,60 @@ type Config struct { // TLSConfig allows the user to set their own TLS config for the HTTP // Client. If set, this option overrides InsecureSkipVerify. TLSConfig *tls.Config + + // Optional credentials for authenticating with the server. + Credentials *Credentials +} + +// AuthenticationMethod defines the type of authentication used. +type AuthenticationMethod int + +// Supported authentication methods. +const ( + _ AuthenticationMethod = iota + UserAuthentication + BearerAuthentication +) + +// Set of credentials depending on the authentication method +type Credentials struct { + Method AuthenticationMethod + + // UserAuthentication fields + + Username string + Password string + + // BearerAuthentication fields + + Token string +} + +func (c Credentials) Validate() error { + switch c.Method { + case UserAuthentication: + if c.Username == "" { + return errors.New("missing username") + } + if c.Password == "" { + return errors.New("missing password") + } + case BearerAuthentication: + if c.Token == "" { + return errors.New("missing token") + } + default: + return errors.New("missing authentication method") + } + return nil } // Basic HTTP client type Client struct { - url *url.URL - userAgent string - httpClient *http.Client + url *url.URL + userAgent string + httpClient *http.Client + credentials *Credentials } // Create a new client. @@ -82,6 +131,12 @@ func New(conf Config) (*Client, error) { ) } + if conf.Credentials != nil { + if err := conf.Credentials.Validate(); err != nil { + return nil, errors.Wrap(err, "invalid credentials") + } + } + tr := &http.Transport{ TLSClientConfig: &tls.Config{ InsecureSkipVerify: conf.InsecureSkipVerify, @@ -97,6 +152,7 @@ func New(conf Config) (*Client, error) { Timeout: conf.Timeout, Transport: tr, }, + credentials: conf.Credentials, }, nil } @@ -545,11 +601,25 @@ func (c *Client) URL() string { return c.url.String() } +func (c *Client) BaseURL() url.URL { + return *c.url +} + // Perform the request. // If result is not nil the response body is JSON decoded into result. // Codes is a list of valid response codes. -func (c *Client) do(req *http.Request, result interface{}, codes ...int) (*http.Response, error) { +func (c *Client) Do(req *http.Request, result interface{}, codes ...int) (*http.Response, error) { req.Header.Set("User-Agent", c.userAgent) + if c.credentials != nil { + switch c.credentials.Method { + case UserAuthentication: + req.SetBasicAuth(c.credentials.Username, c.credentials.Password) + case BearerAuthentication: + req.Header.Set("Authorization", "Bearer "+c.credentials.Token) + default: + return nil, errors.New("unknown authentication method set") + } + } resp, err := c.httpClient.Do(req) if err != nil { return nil, err @@ -601,7 +671,7 @@ func (c *Client) Ping() (time.Duration, string, error) { return 0, "", err } - resp, err := c.do(req, nil, http.StatusNoContent) + resp, err := c.Do(req, nil, http.StatusNoContent) if err != nil { return 0, "", err } @@ -646,7 +716,7 @@ func (c *Client) CreateTask(opt CreateTaskOptions) (Task, error) { } t := Task{} - _, err = c.do(req, &t, http.StatusOK) + _, err = c.Do(req, &t, http.StatusOK) return t, err } @@ -683,7 +753,7 @@ func (c *Client) UpdateTask(link Link, opt UpdateTaskOptions) (Task, error) { return t, err } - _, err = c.do(req, &t, http.StatusOK) + _, err = c.Do(req, &t, http.StatusOK) if err != nil { return t, err } @@ -737,7 +807,7 @@ func (c *Client) Task(link Link, opt *TaskOptions) (Task, error) { return task, err } - _, err = c.do(req, &task, http.StatusOK) + _, err = c.Do(req, &task, http.StatusOK) if err != nil { return task, err } @@ -758,7 +828,7 @@ func (c *Client) DeleteTask(link Link) error { return err } - _, err = c.do(req, nil, http.StatusNoContent) + _, err = c.Do(req, nil, http.StatusNoContent) return err } @@ -811,7 +881,7 @@ func (c *Client) ListTasks(opt *ListTasksOptions) ([]Task, error) { r := &response{} - _, err = c.do(req, r, http.StatusOK) + _, err = c.Do(req, r, http.StatusOK) if err != nil { return nil, err } @@ -827,7 +897,7 @@ func (c *Client) TaskOutput(link Link, name string) (*influxql.Result, error) { return nil, err } r := &influxql.Result{} - _, err = c.do(req, r, http.StatusOK) + _, err = c.Do(req, r, http.StatusOK) if err != nil { return nil, err } @@ -859,7 +929,7 @@ func (c *Client) CreateTemplate(opt CreateTemplateOptions) (Template, error) { } t := Template{} - _, err = c.do(req, &t, http.StatusOK) + _, err = c.Do(req, &t, http.StatusOK) return t, err } @@ -892,7 +962,7 @@ func (c *Client) UpdateTemplate(link Link, opt UpdateTemplateOptions) (Template, return t, err } - _, err = c.do(req, &t, http.StatusOK) + _, err = c.Do(req, &t, http.StatusOK) if err != nil { return t, err } @@ -938,7 +1008,7 @@ func (c *Client) Template(link Link, opt *TemplateOptions) (Template, error) { return template, err } - _, err = c.do(req, &template, http.StatusOK) + _, err = c.Do(req, &template, http.StatusOK) if err != nil { return template, err } @@ -959,7 +1029,7 @@ func (c *Client) DeleteTemplate(link Link) error { return err } - _, err = c.do(req, nil, http.StatusNoContent) + _, err = c.Do(req, nil, http.StatusNoContent) return err } @@ -1012,7 +1082,7 @@ func (c *Client) ListTemplates(opt *ListTemplatesOptions) ([]Template, error) { r := &response{} - _, err = c.do(req, r, http.StatusOK) + _, err = c.Do(req, r, http.StatusOK) if err != nil { return nil, err } @@ -1034,7 +1104,7 @@ func (c *Client) Recording(link Link) (Recording, error) { return r, err } - _, err = c.do(req, &r, http.StatusOK, http.StatusAccepted) + _, err = c.Do(req, &r, http.StatusOK, http.StatusAccepted) if err != nil { return r, err } @@ -1071,7 +1141,7 @@ func (c *Client) RecordStream(opt RecordStreamOptions) (Recording, error) { return r, err } - _, err = c.do(req, &r, http.StatusCreated) + _, err = c.Do(req, &r, http.StatusCreated) if err != nil { return r, err } @@ -1105,7 +1175,7 @@ func (c *Client) RecordBatch(opt RecordBatchOptions) (Recording, error) { return r, err } - _, err = c.do(req, &r, http.StatusCreated) + _, err = c.Do(req, &r, http.StatusCreated) if err != nil { return r, err } @@ -1140,7 +1210,7 @@ func (c *Client) RecordQuery(opt RecordQueryOptions) (Recording, error) { return r, err } - _, err = c.do(req, &r, http.StatusCreated) + _, err = c.Do(req, &r, http.StatusCreated) if err != nil { return r, err } @@ -1160,7 +1230,7 @@ func (c *Client) DeleteRecording(link Link) error { return err } - _, err = c.do(req, nil, http.StatusNoContent) + _, err = c.Do(req, nil, http.StatusNoContent) return err } @@ -1210,7 +1280,7 @@ func (c *Client) ListRecordings(opt *ListRecordingsOptions) ([]Recording, error) r := &response{} - _, err = c.do(req, r, http.StatusOK) + _, err = c.Do(req, r, http.StatusOK) if err != nil { return nil, err } @@ -1253,7 +1323,7 @@ func (c *Client) CreateReplay(opt CreateReplayOptions) (Replay, error) { return r, err } - _, err = c.do(req, &r, http.StatusCreated) + _, err = c.Do(req, &r, http.StatusCreated) if err != nil { return r, err } @@ -1288,7 +1358,7 @@ func (c *Client) ReplayBatch(opt ReplayBatchOptions) (Replay, error) { return r, err } - _, err = c.do(req, &r, http.StatusCreated) + _, err = c.Do(req, &r, http.StatusCreated) if err != nil { return r, err } @@ -1323,7 +1393,7 @@ func (c *Client) ReplayQuery(opt ReplayQueryOptions) (Replay, error) { return r, err } - _, err = c.do(req, &r, http.StatusCreated) + _, err = c.Do(req, &r, http.StatusCreated) if err != nil { return r, err } @@ -1345,7 +1415,7 @@ func (c *Client) Replay(link Link) (Replay, error) { return r, err } - _, err = c.do(req, &r, http.StatusOK, http.StatusAccepted) + _, err = c.Do(req, &r, http.StatusOK, http.StatusAccepted) if err != nil { return r, err } @@ -1365,7 +1435,7 @@ func (c *Client) DeleteReplay(link Link) error { return err } - _, err = c.do(req, nil, http.StatusNoContent) + _, err = c.Do(req, nil, http.StatusNoContent) if err != nil { return err } @@ -1418,7 +1488,7 @@ func (c *Client) ListReplays(opt *ListReplaysOptions) ([]Replay, error) { r := &response{} - _, err = c.do(req, r, http.StatusOK) + _, err = c.Do(req, r, http.StatusOK) if err != nil { return nil, err } @@ -1448,7 +1518,7 @@ func (c *Client) LogLevel(level string) error { return err } - _, err = c.do(req, nil, http.StatusNoContent) + _, err = c.Do(req, nil, http.StatusNoContent) return err } @@ -1482,6 +1552,6 @@ func (c *Client) DebugVars() (DebugVars, error) { } vars := DebugVars{} - _, err = c.do(req, &vars, http.StatusOK) + _, err = c.Do(req, &vars, http.StatusOK) return vars, err } diff --git a/client/v1/client_test.go b/client/v1/client_test.go index 0afdaf406..e7235bdcf 100644 --- a/client/v1/client_test.go +++ b/client/v1/client_test.go @@ -2,6 +2,7 @@ package client_test import ( "encoding/json" + "errors" "fmt" "io/ioutil" "net/http" @@ -16,10 +17,12 @@ import ( ) func newClient(handler http.Handler) (*httptest.Server, *client.Client, error) { + return newClientWithConfig(handler, client.Config{}) +} + +func newClientWithConfig(handler http.Handler, config client.Config) (*httptest.Server, *client.Client, error) { ts := httptest.NewServer(handler) - config := client.Config{ - URL: ts.URL, - } + config.URL = ts.URL cli, err := client.New(config) return ts, cli, err } @@ -1910,3 +1913,107 @@ func Test_LogLevel(t *testing.T) { t.Fatal(err) } } + +func Test_Bad_Creds(t *testing.T) { + testCases := []struct { + creds *client.Credentials + err error + }{ + { + creds: &client.Credentials{ + Method: client.UserAuthentication, + }, + err: errors.New("invalid credentials: missing username"), + }, + { + creds: &client.Credentials{ + Method: client.UserAuthentication, + Username: "bob", + }, + err: errors.New("invalid credentials: missing password"), + }, + { + creds: &client.Credentials{ + Method: client.BearerAuthentication, + }, + err: errors.New("invalid credentials: missing token"), + }, + } + for _, tc := range testCases { + if _, err := client.New( + client.Config{ + URL: "http://localhost", + Credentials: tc.creds, + }, + ); err == nil { + t.Error("expected credential error") + } else if exp, got := tc.err.Error(), err.Error(); got != exp { + t.Errorf("unexpected error message: got %q exp %q", got, exp) + } + } +} + +func Test_UserAuthentication(t *testing.T) { + s, c, err := newClientWithConfig(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { + u, p, auth := r.BasicAuth() + if r.URL.Path == "/kapacitor/v1/ping" && r.Method == "GET" && + auth && + u == "bob" && + p == "don't look" { + w.Header().Set("X-Kapacitor-Version", "versionStr") + w.WriteHeader(http.StatusNoContent) + } else { + w.WriteHeader(http.StatusBadRequest) + fmt.Fprintf(w, "request: %v", r) + } + }), client.Config{ + Credentials: &client.Credentials{ + Method: client.UserAuthentication, + Username: "bob", + Password: "don't look", + }, + }) + if err != nil { + t.Fatal(err) + } + defer s.Close() + + _, version, err := c.Ping() + if err != nil { + t.Fatal(err) + } + if exp, got := "versionStr", version; exp != got { + t.Errorf("unexpected version: got: %s exp: %s", got, exp) + } +} + +func Test_BearerAuthentication(t *testing.T) { + s, c, err := newClientWithConfig(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { + auth := r.Header.Get("Authorization") + if r.URL.Path == "/kapacitor/v1/ping" && r.Method == "GET" && + auth == "Bearer myfake.token" { + w.Header().Set("X-Kapacitor-Version", "versionStr") + w.WriteHeader(http.StatusNoContent) + } else { + w.WriteHeader(http.StatusBadRequest) + fmt.Fprintf(w, "request: %v", r) + } + }), client.Config{ + Credentials: &client.Credentials{ + Method: client.BearerAuthentication, + Token: "myfake.token", + }, + }) + if err != nil { + t.Fatal(err) + } + defer s.Close() + + _, version, err := c.Ping() + if err != nil { + t.Fatal(err) + } + if exp, got := "versionStr", version; exp != got { + t.Errorf("unexpected version: got: %s exp: %s", got, exp) + } +} diff --git a/integrations/benchmark_test.go b/integrations/benchmark_test.go index 1cb47caa7..87f7963d5 100644 --- a/integrations/benchmark_test.go +++ b/integrations/benchmark_test.go @@ -25,6 +25,7 @@ import ( "github.com/influxdata/kapacitor" "github.com/influxdata/kapacitor/services/httpd" + "github.com/influxdata/kapacitor/services/noauth" ) const ( @@ -128,7 +129,7 @@ func Bench(b *testing.B, tasksCount, pointCount int, db, rp, measurement, tickSc config.BindAddress = ":0" // Choose port dynamically httpdService := httpd.NewService(config, logService.NewLogger("[http] ", log.LstdFlags), logService) - httpdService.Handler.MetaClient = &kapacitor.NoopMetaClient{} + httpdService.Handler.AuthService = noauth.NewService(logService.NewLogger("[noauth] ", log.LstdFlags)) err := httpdService.Open() if err != nil { b.Fatal(err) diff --git a/integrations/helpers_test.go b/integrations/helpers_test.go index e98ce8f11..bd9176769 100644 --- a/integrations/helpers_test.go +++ b/integrations/helpers_test.go @@ -14,6 +14,7 @@ import ( client "github.com/influxdata/influxdb/client/v2" "github.com/influxdata/influxdb/influxql" "github.com/influxdata/kapacitor" + "github.com/influxdata/kapacitor/services/logging" "github.com/influxdata/kapacitor/udf" "github.com/influxdata/wlog" ) @@ -132,12 +133,12 @@ func (l *LogService) NewRawLogger(prefix string, flag int) *log.Logger { return log.New(os.Stderr, prefix, flag) } -func (l *LogService) NewStaticLevelLogger(prefix string, flag int, level wlog.Level) *log.Logger { - return log.New(wlog.NewStaticLevelWriter(os.Stderr, level), prefix, flag) +func (l *LogService) NewStaticLevelLogger(prefix string, flag int, level logging.Level) *log.Logger { + return log.New(wlog.NewStaticLevelWriter(os.Stderr, wlog.Level(level)), prefix, flag) } -func (l *LogService) NewStaticLevelWriter(level wlog.Level) io.Writer { - return wlog.NewStaticLevelWriter(os.Stderr, level) +func (l *LogService) NewStaticLevelWriter(level logging.Level) io.Writer { + return wlog.NewStaticLevelWriter(os.Stderr, wlog.Level(level)) } type UDFService struct { diff --git a/server/server.go b/server/server.go index 45fa3298c..c2f7a9104 100644 --- a/server/server.go +++ b/server/server.go @@ -2,7 +2,6 @@ package server import ( - "errors" "fmt" "io/ioutil" "log" @@ -18,12 +17,14 @@ import ( "github.com/influxdata/influxdb/services/meta" "github.com/influxdata/influxdb/services/opentsdb" "github.com/influxdata/kapacitor" + "github.com/influxdata/kapacitor/auth" "github.com/influxdata/kapacitor/services/alerta" "github.com/influxdata/kapacitor/services/deadman" "github.com/influxdata/kapacitor/services/hipchat" "github.com/influxdata/kapacitor/services/httpd" "github.com/influxdata/kapacitor/services/influxdb" "github.com/influxdata/kapacitor/services/logging" + "github.com/influxdata/kapacitor/services/noauth" "github.com/influxdata/kapacitor/services/opsgenie" "github.com/influxdata/kapacitor/services/pagerduty" "github.com/influxdata/kapacitor/services/replay" @@ -39,7 +40,7 @@ import ( "github.com/influxdata/kapacitor/services/udf" "github.com/influxdata/kapacitor/services/udp" "github.com/influxdata/kapacitor/services/victorops" - "github.com/influxdata/wlog" + "github.com/pkg/errors" "github.com/twinj/uuid" ) @@ -61,12 +62,14 @@ type Server struct { dataDir string hostname string + config *Config + err chan error TaskMaster *kapacitor.TaskMaster TaskMasterLookup *kapacitor.TaskMasterLookup - LogService logging.Interface + AuthService auth.Interface HTTPDService *httpd.Service StorageService *storage.Service TaskStore *task_store.Service @@ -85,7 +88,8 @@ type Server struct { CPUProfile string MemProfile string - Logger *log.Logger + LogService logging.Interface + Logger *log.Logger } // New returns a new instance of Server built from a config. @@ -96,6 +100,7 @@ func New(c *Config, buildInfo BuildInfo, logService logging.Interface) (*Server, } l := logService.NewLogger("[srv] ", log.LstdFlags) s := &Server{ + config: c, buildInfo: buildInfo, dataDir: c.DataDir, hostname: c.Hostname, @@ -127,66 +132,19 @@ func New(c *Config, buildInfo BuildInfo, logService logging.Interface) (*Server, if err := s.TaskMaster.Open(); err != nil { return nil, err } - - // Determine HTTP port - httpPort, err := c.HTTP.Port() - if err != nil { - return nil, err - } - - // Append Kapacitor services. - s.appendUDFService(c.UDF) - s.appendDeadmanService(c.Deadman) - s.appendSMTPService(c.SMTP) - s.initHTTPDService(c.HTTP) - s.appendInfluxDBService(c.InfluxDB, c.defaultInfluxDB, httpPort, c.Hostname) - s.appendStorageService(c.Storage) - s.appendTaskStoreService(c.Task) - s.appendReplayService(c.Replay) - s.appendOpsGenieService(c.OpsGenie) - s.appendVictorOpsService(c.VictorOps) - s.appendPagerDutyService(c.PagerDuty) - s.appendTelegramService(c.Telegram) - s.appendHipChatService(c.HipChat) - s.appendAlertaService(c.Alerta) - s.appendSlackService(c.Slack) - s.appendSensuService(c.Sensu) - s.appendTalkService(c.Talk) - - // Append InfluxDB services - s.appendCollectdService(c.Collectd) - if err := s.appendOpenTSDBService(c.OpenTSDB); err != nil { - return nil, err - } - for _, g := range c.UDPs { - s.appendUDPService(g) - } - for _, g := range c.Graphites { - if err := s.appendGraphiteService(g); err != nil { - return nil, err - } - } - - // append StatsService and ReportingService last so all stats are ready - // to be reported - s.appendStatsService(c.Stats) - s.appendReportingService(c.Reporting) - - // Append HTTPD Service last - s.appendHTTPDService() - return s, nil } -func (s *Server) appendStorageService(c storage.Config) { +func (s *Server) AppendStorageService() { l := s.LogService.NewLogger("[storage] ", log.LstdFlags) - srv := storage.NewService(c, l) + srv := storage.NewService(s.config.Storage, l) s.StorageService = srv s.Services = append(s.Services, srv) } -func (s *Server) appendSMTPService(c smtp.Config) { +func (s *Server) AppendSMTPService() { + c := s.config.SMTP if c.Enabled { l := s.LogService.NewLogger("[smtp] ", log.LstdFlags) srv := smtp.NewService(c, l) @@ -196,10 +154,15 @@ func (s *Server) appendSMTPService(c smtp.Config) { } } -func (s *Server) appendInfluxDBService(c []influxdb.Config, defaultInfluxDB, httpPort int, hostname string) { +func (s *Server) AppendInfluxDBService() error { + c := s.config.InfluxDB if len(c) > 0 { l := s.LogService.NewLogger("[influxdb] ", log.LstdFlags) - srv := influxdb.NewService(c, defaultInfluxDB, httpPort, hostname, l) + httpPort, err := s.config.HTTP.Port() + if err != nil { + return errors.Wrap(err, "failed to get http port") + } + srv := influxdb.NewService(c, s.config.defaultInfluxDB, httpPort, s.config.Hostname, l) srv.PointsWriter = s.TaskMaster srv.LogService = s.LogService @@ -207,13 +170,13 @@ func (s *Server) appendInfluxDBService(c []influxdb.Config, defaultInfluxDB, htt s.TaskMaster.InfluxDBService = srv s.Services = append(s.Services, srv) } + return nil } -func (s *Server) initHTTPDService(c httpd.Config) { +func (s *Server) InitHTTPDService() { l := s.LogService.NewLogger("[httpd] ", log.LstdFlags) - srv := httpd.NewService(c, l, s.LogService) + srv := httpd.NewService(s.config.HTTP, l, s.LogService) - srv.Handler.MetaClient = s.MetaClient srv.Handler.PointsWriter = s.TaskMaster srv.Handler.Version = s.buildInfo.Version @@ -221,13 +184,13 @@ func (s *Server) initHTTPDService(c httpd.Config) { s.TaskMaster.HTTPDService = srv } -func (s *Server) appendHTTPDService() { +func (s *Server) AppendHTTPDService() { s.Services = append(s.Services, s.HTTPDService) } -func (s *Server) appendTaskStoreService(c task_store.Config) { +func (s *Server) AppendTaskStoreService() { l := s.LogService.NewLogger("[task_store] ", log.LstdFlags) - srv := task_store.NewService(c, l) + srv := task_store.NewService(s.config.Task, l) srv.StorageService = s.StorageService srv.HTTPDService = s.HTTPDService srv.TaskMasterLookup = s.TaskMasterLookup @@ -237,9 +200,9 @@ func (s *Server) appendTaskStoreService(c task_store.Config) { s.Services = append(s.Services, srv) } -func (s *Server) appendReplayService(c replay.Config) { +func (s *Server) AppendReplayService() { l := s.LogService.NewLogger("[replay] ", log.LstdFlags) - srv := replay.NewService(c, l) + srv := replay.NewService(s.config.Replay, l) srv.StorageService = s.StorageService srv.TaskStore = s.TaskStore srv.HTTPDService = s.HTTPDService @@ -251,23 +214,33 @@ func (s *Server) appendReplayService(c replay.Config) { s.Services = append(s.Services, srv) } -func (s *Server) appendDeadmanService(c deadman.Config) { +func (s *Server) AppendDeadmanService() { l := s.LogService.NewLogger("[deadman] ", log.LstdFlags) - srv := deadman.NewService(c, l) + srv := deadman.NewService(s.config.Deadman, l) s.TaskMaster.DeadmanService = srv s.Services = append(s.Services, srv) } -func (s *Server) appendUDFService(c udf.Config) { +func (s *Server) AppendUDFService() { l := s.LogService.NewLogger("[udf] ", log.LstdFlags) - srv := udf.NewService(c, l) + srv := udf.NewService(s.config.UDF, l) s.TaskMaster.UDFService = srv s.Services = append(s.Services, srv) } -func (s *Server) appendOpsGenieService(c opsgenie.Config) { +func (s *Server) AppendAuthService() { + l := s.LogService.NewLogger("[noauth] ", log.LstdFlags) + srv := noauth.NewService(l) + + s.AuthService = srv + s.HTTPDService.Handler.AuthService = srv + s.Services = append(s.Services, srv) +} + +func (s *Server) AppendOpsGenieService() { + c := s.config.OpsGenie if c.Enabled { l := s.LogService.NewLogger("[opsgenie] ", log.LstdFlags) srv := opsgenie.NewService(c, l) @@ -277,7 +250,8 @@ func (s *Server) appendOpsGenieService(c opsgenie.Config) { } } -func (s *Server) appendVictorOpsService(c victorops.Config) { +func (s *Server) AppendVictorOpsService() { + c := s.config.VictorOps if c.Enabled { l := s.LogService.NewLogger("[victorops] ", log.LstdFlags) srv := victorops.NewService(c, l) @@ -287,7 +261,8 @@ func (s *Server) appendVictorOpsService(c victorops.Config) { } } -func (s *Server) appendPagerDutyService(c pagerduty.Config) { +func (s *Server) AppendPagerDutyService() { + c := s.config.PagerDuty if c.Enabled { l := s.LogService.NewLogger("[pagerduty] ", log.LstdFlags) srv := pagerduty.NewService(c, l) @@ -298,7 +273,8 @@ func (s *Server) appendPagerDutyService(c pagerduty.Config) { } } -func (s *Server) appendSensuService(c sensu.Config) { +func (s *Server) AppendSensuService() { + c := s.config.Sensu if c.Enabled { l := s.LogService.NewLogger("[sensu] ", log.LstdFlags) srv := sensu.NewService(c, l) @@ -308,7 +284,8 @@ func (s *Server) appendSensuService(c sensu.Config) { } } -func (s *Server) appendSlackService(c slack.Config) { +func (s *Server) AppendSlackService() { + c := s.config.Slack if c.Enabled { l := s.LogService.NewLogger("[slack] ", log.LstdFlags) srv := slack.NewService(c, l) @@ -318,7 +295,8 @@ func (s *Server) appendSlackService(c slack.Config) { } } -func (s *Server) appendTelegramService(c telegram.Config) { +func (s *Server) AppendTelegramService() { + c := s.config.Telegram if c.Enabled { l := s.LogService.NewLogger("[telegram] ", log.LstdFlags) srv := telegram.NewService(c, l) @@ -328,7 +306,8 @@ func (s *Server) appendTelegramService(c telegram.Config) { } } -func (s *Server) appendHipChatService(c hipchat.Config) { +func (s *Server) AppendHipChatService() { + c := s.config.HipChat if c.Enabled { l := s.LogService.NewLogger("[hipchat] ", log.LstdFlags) srv := hipchat.NewService(c, l) @@ -338,7 +317,8 @@ func (s *Server) appendHipChatService(c hipchat.Config) { } } -func (s *Server) appendAlertaService(c alerta.Config) { +func (s *Server) AppendAlertaService() { + c := s.config.Alerta if c.Enabled { l := s.LogService.NewLogger("[alerta] ", log.LstdFlags) srv := alerta.NewService(c, l) @@ -348,12 +328,24 @@ func (s *Server) appendAlertaService(c alerta.Config) { } } -func (s *Server) appendCollectdService(c collectd.Config) { +func (s *Server) AppendTalkService() { + c := s.config.Talk + if c.Enabled { + l := s.LogService.NewLogger("[talk] ", log.LstdFlags) + srv := talk.NewService(c, l) + s.TaskMaster.TalkService = srv + + s.Services = append(s.Services, srv) + } +} + +func (s *Server) AppendCollectdService() { + c := s.config.Collectd if !c.Enabled { return } srv := collectd.NewService(c) - w := s.LogService.NewStaticLevelWriter(wlog.INFO) + w := s.LogService.NewStaticLevelWriter(logging.INFO) srv.SetLogOutput(w) srv.MetaClient = s.MetaClient @@ -361,7 +353,8 @@ func (s *Server) appendCollectdService(c collectd.Config) { s.Services = append(s.Services, srv) } -func (s *Server) appendOpenTSDBService(c opentsdb.Config) error { +func (s *Server) AppendOpenTSDBService() error { + c := s.config.OpenTSDB if !c.Enabled { return nil } @@ -369,7 +362,7 @@ func (s *Server) appendOpenTSDBService(c opentsdb.Config) error { if err != nil { return err } - w := s.LogService.NewStaticLevelWriter(wlog.INFO) + w := s.LogService.NewStaticLevelWriter(logging.INFO) srv.SetLogOutput(w) srv.PointsWriter = s.TaskMaster @@ -378,34 +371,39 @@ func (s *Server) appendOpenTSDBService(c opentsdb.Config) error { return nil } -func (s *Server) appendGraphiteService(c graphite.Config) error { - if !c.Enabled { - return nil - } - srv, err := graphite.NewService(c) - if err != nil { - return err - } - w := s.LogService.NewStaticLevelWriter(wlog.INFO) - srv.SetLogOutput(w) +func (s *Server) AppendGraphiteServices() error { + for _, c := range s.config.Graphites { + if !c.Enabled { + continue + } + srv, err := graphite.NewService(c) + if err != nil { + return errors.Wrap(err, "creating new graphite service") + } + w := s.LogService.NewStaticLevelWriter(logging.INFO) + srv.SetLogOutput(w) - srv.PointsWriter = s.TaskMaster - srv.MetaClient = s.MetaClient - s.Services = append(s.Services, srv) + srv.PointsWriter = s.TaskMaster + srv.MetaClient = s.MetaClient + s.Services = append(s.Services, srv) + } return nil } -func (s *Server) appendUDPService(c udp.Config) { - if !c.Enabled { - return +func (s *Server) AppendUDPServices() { + for _, c := range s.config.UDPs { + if !c.Enabled { + continue + } + l := s.LogService.NewLogger("[udp] ", log.LstdFlags) + srv := udp.NewService(c, l) + srv.PointsWriter = s.TaskMaster + s.Services = append(s.Services, srv) } - l := s.LogService.NewLogger("[udp] ", log.LstdFlags) - srv := udp.NewService(c, l) - srv.PointsWriter = s.TaskMaster - s.Services = append(s.Services, srv) } -func (s *Server) appendStatsService(c stats.Config) { +func (s *Server) AppendStatsService() { + c := s.config.Stats if c.Enabled { l := s.LogService.NewLogger("[stats] ", log.LstdFlags) srv := stats.NewService(c, l) @@ -416,7 +414,8 @@ func (s *Server) appendStatsService(c stats.Config) { } } -func (s *Server) appendReportingService(c reporting.Config) { +func (s *Server) AppendReportingService() { + c := s.config.Reporting if c.Enabled { l := s.LogService.NewLogger("[reporting] ", log.LstdFlags) srv := reporting.NewService(c, l) @@ -425,52 +424,121 @@ func (s *Server) appendReportingService(c reporting.Config) { } } -func (s *Server) appendTalkService(c talk.Config) { - if c.Enabled { - l := s.LogService.NewLogger("[talk] ", log.LstdFlags) - srv := talk.NewService(c, l) - s.TaskMaster.TalkService = srv - - s.Services = append(s.Services, srv) - } -} - // Err returns an error channel that multiplexes all out of band errors received from all services. func (s *Server) Err() <-chan error { return s.err } -// Open opens all the services. -func (s *Server) Open() error { - if err := func() error { +type ServiceProvider interface { + AppendUDFService() + AppendDeadmanService() + AppendSMTPService() + AppendAuthService() + InitHTTPDService() + AppendInfluxDBService() error + AppendStorageService() + AppendTaskStoreService() + AppendReplayService() + AppendOpsGenieService() + AppendVictorOpsService() + AppendPagerDutyService() + AppendTelegramService() + AppendHipChatService() + AppendAlertaService() + AppendSlackService() + AppendSensuService() + AppendTalkService() + AppendCollectdService() + AppendUDPServices() + AppendOpenTSDBService() error + AppendGraphiteServices() error + AppendStatsService() + AppendReportingService() + AppendHTTPDService() +} + +// Append all services +func DoAppendServices(s ServiceProvider) error { + // Append Kapacitor services. + s.AppendUDFService() + s.AppendDeadmanService() + s.AppendSMTPService() + s.InitHTTPDService() + if err := s.AppendInfluxDBService(); err != nil { + return errors.Wrap(err, "influxdb service") + } + s.AppendStorageService() + s.AppendTaskStoreService() + s.AppendReplayService() + s.AppendAuthService() + + // Append Alert integration services + s.AppendOpsGenieService() + s.AppendVictorOpsService() + s.AppendPagerDutyService() + s.AppendTelegramService() + s.AppendHipChatService() + s.AppendAlertaService() + s.AppendSlackService() + s.AppendSensuService() + s.AppendTalkService() + + // Append InfluxDB input services + s.AppendCollectdService() + s.AppendUDPServices() + if err := s.AppendOpenTSDBService(); err != nil { + return errors.Wrap(err, "opentsdb service") + } + if err := s.AppendGraphiteServices(); err != nil { + return errors.Wrap(err, "graphite service") + } + + // Append StatsService and ReportingService after other services so all stats are ready + // to be reported + s.AppendStatsService() + s.AppendReportingService() - // Start profiling, if set. - s.startProfile(s.CPUProfile, s.MemProfile) + // Append HTTPD Service last so that the API is not listening till everything else succeeded. + s.AppendHTTPDService() - for _, service := range s.Services { - s.Logger.Printf("D! opening service: %T", service) - if err := service.Open(); err != nil { - return fmt.Errorf("open service %T: %s", service, err) - } - s.Logger.Printf("D! opened service: %T", service) - } - return nil + return nil +} - }(); err != nil { +// Open opens all the services. +func (s *Server) Open() error { + if err := DoAppendServices(s); err != nil { + return err + } + if err := s.StartServices(); err != nil { s.Close() return err } - go func() { - // Watch if something dies - var err error - select { - case err = <-s.HTTPDService.Err(): - } - s.err <- err - }() + go s.WatchServices() return nil } +func (s *Server) StartServices() error { + // Start profiling, if set. + s.startProfile(s.CPUProfile, s.MemProfile) + for _, service := range s.Services { + s.Logger.Printf("D! opening service: %T", service) + if err := service.Open(); err != nil { + return fmt.Errorf("open service %T: %s", service, err) + } + s.Logger.Printf("D! opened service: %T", service) + } + return nil +} + +// Watch if something dies +func (s *Server) WatchServices() { + var err error + select { + case err = <-s.HTTPDService.Err(): + } + s.err <- err +} + // Close shuts down the meta and data stores and all services. func (s *Server) Close() error { s.stopProfile() diff --git a/server/server_helper_test.go b/server/server_helper_test.go index 9d0b4b343..636ae9d74 100644 --- a/server/server_helper_test.go +++ b/server/server_helper_test.go @@ -18,6 +18,7 @@ import ( iclient "github.com/influxdata/influxdb/client/v2" "github.com/influxdata/kapacitor/client/v1" "github.com/influxdata/kapacitor/server" + "github.com/influxdata/kapacitor/services/logging" "github.com/influxdata/wlog" ) @@ -213,12 +214,12 @@ func (l *LogService) NewRawLogger(prefix string, flag int) *log.Logger { return log.New(os.Stderr, prefix, flag) } -func (l *LogService) NewStaticLevelLogger(prefix string, flag int, level wlog.Level) *log.Logger { - return log.New(wlog.NewStaticLevelWriter(os.Stderr, level), prefix, flag) +func (l *LogService) NewStaticLevelLogger(prefix string, flag int, level logging.Level) *log.Logger { + return log.New(wlog.NewStaticLevelWriter(os.Stderr, wlog.Level(level)), prefix, flag) } -func (l *LogService) NewStaticLevelWriter(level wlog.Level) io.Writer { - return wlog.NewStaticLevelWriter(os.Stderr, level) +func (l *LogService) NewStaticLevelWriter(level logging.Level) io.Writer { + return wlog.NewStaticLevelWriter(os.Stderr, wlog.Level(level)) } type queryFunc func(q string) *iclient.Response diff --git a/server/server_test.go b/server/server_test.go index 608012d83..32251b66b 100644 --- a/server/server_test.go +++ b/server/server_test.go @@ -18,6 +18,7 @@ import ( "testing" "time" + "github.com/dgrijalva/jwt-go" iclient "github.com/influxdata/influxdb/client/v2" "github.com/influxdata/influxdb/influxql" "github.com/influxdata/influxdb/models" @@ -36,7 +37,165 @@ func init() { func TestServer_Ping(t *testing.T) { s, cli := OpenDefaultServer() - t.Log(s.URL()) + defer s.Close() + _, version, err := cli.Ping() + if err != nil { + t.Fatal(err) + } + if version != "testServer" { + t.Fatal("unexpected version", version) + } +} +func TestServer_Authenticate_Fail(t *testing.T) { + conf := NewConfig() + conf.HTTP.AuthEnabled = true + s := OpenServer(conf) + cli, err := client.New(client.Config{ + URL: s.URL(), + }) + if err != nil { + t.Fatal(err) + } + defer s.Close() + _, _, err = cli.Ping() + if err == nil { + t.Error("expected authentication error") + } else if exp, got := "unable to parse authentication credentials", err.Error(); got != exp { + t.Errorf("unexpected error message: got %q exp %q", got, exp) + } +} + +func TestServer_Authenticate_User(t *testing.T) { + conf := NewConfig() + conf.HTTP.AuthEnabled = true + s := OpenServer(conf) + cli, err := client.New(client.Config{ + URL: s.URL(), + Credentials: &client.Credentials{ + Method: client.UserAuthentication, + Username: "bob", + Password: "bob's secure password", + }, + }) + if err != nil { + t.Fatal(err) + } + defer s.Close() + _, version, err := cli.Ping() + if err != nil { + t.Fatal(err) + } + if version != "testServer" { + t.Fatal("unexpected version", version) + } +} + +func TestServer_Authenticate_Bearer_Fail(t *testing.T) { + secret := "secret" + // Create a new token object, specifying signing method and the claims + // you would like it to contain. + token := jwt.NewWithClaims(jwt.SigningMethodHS512, jwt.MapClaims{ + "username": "bob", + "exp": time.Now().Add(10 * time.Second).Unix(), + }) + + // Sign and get the complete encoded token as a string using the secret + tokenString, err := token.SignedString([]byte(secret)) + if err != nil { + t.Fatal(err) + } + + conf := NewConfig() + conf.HTTP.AuthEnabled = true + // Use a different secret so the token is invalid + conf.HTTP.SharedSecret = secret + "extra secret" + s := OpenServer(conf) + cli, err := client.New(client.Config{ + URL: s.URL(), + Credentials: &client.Credentials{ + Method: client.BearerAuthentication, + Token: tokenString, + }, + }) + if err != nil { + t.Fatal(err) + } + defer s.Close() + _, _, err = cli.Ping() + if err == nil { + t.Error("expected authentication error") + } else if exp, got := "invalid token: signature is invalid", err.Error(); got != exp { + t.Errorf("unexpected error message: got %q exp %q", got, exp) + } +} + +func TestServer_Authenticate_Bearer_Expired(t *testing.T) { + secret := "secret" + // Create a new token object, specifying signing method and the claims + // you would like it to contain. + token := jwt.NewWithClaims(jwt.SigningMethodHS512, jwt.MapClaims{ + "username": "bob", + "exp": time.Now().Add(-10 * time.Second).Unix(), + }) + + // Sign and get the complete encoded token as a string using the secret + tokenString, err := token.SignedString([]byte(secret)) + if err != nil { + t.Fatal(err) + } + + conf := NewConfig() + conf.HTTP.AuthEnabled = true + conf.HTTP.SharedSecret = secret + s := OpenServer(conf) + cli, err := client.New(client.Config{ + URL: s.URL(), + Credentials: &client.Credentials{ + Method: client.BearerAuthentication, + Token: tokenString, + }, + }) + if err != nil { + t.Fatal(err) + } + defer s.Close() + _, _, err = cli.Ping() + if err == nil { + t.Error("expected authentication error") + } else if exp, got := "invalid token: Token is expired", err.Error(); got != exp { + t.Errorf("unexpected error message: got %q exp %q", got, exp) + } +} + +func TestServer_Authenticate_Bearer(t *testing.T) { + secret := "secret" + // Create a new token object, specifying signing method and the claims + // you would like it to contain. + token := jwt.NewWithClaims(jwt.SigningMethodHS512, jwt.MapClaims{ + "username": "bob", + "exp": time.Now().Add(10 * time.Second).Unix(), + }) + + // Sign and get the complete encoded token as a string using the secret + tokenString, err := token.SignedString([]byte(secret)) + if err != nil { + t.Fatal(err) + } + + conf := NewConfig() + conf.HTTP.AuthEnabled = true + conf.HTTP.SharedSecret = secret + s := OpenServer(conf) + cli, err := client.New(client.Config{ + URL: s.URL(), + Credentials: &client.Credentials{ + Method: client.BearerAuthentication, + Token: tokenString, + }, + }) + if err != nil { + t.Fatal(err) + } defer s.Close() _, version, err := cli.Ping() if err != nil { diff --git a/services/httpd/config.go b/services/httpd/config.go index 22a8a88b9..1c983a594 100644 --- a/services/httpd/config.go +++ b/services/httpd/config.go @@ -23,6 +23,7 @@ type Config struct { HttpsEnabled bool `toml:"https-enabled"` HttpsCertificate string `toml:"https-certificate"` ShutdownTimeout toml.Duration `toml:"shutdown-timeout"` + SharedSecret string `toml:"shared-secret"` // Enable gzipped encoding // NOTE: this is ignored in toml since it is only consumed by the tests diff --git a/services/httpd/handler.go b/services/httpd/handler.go index 900a6c57a..2d239af5e 100644 --- a/services/httpd/handler.go +++ b/services/httpd/handler.go @@ -3,6 +3,7 @@ package httpd import ( "compress/gzip" "encoding/json" + "errors" "expvar" "fmt" "io" @@ -13,11 +14,12 @@ import ( "strings" "time" + "github.com/dgrijalva/jwt-go" "github.com/influxdata/influxdb" "github.com/influxdata/influxdb/influxql" "github.com/influxdata/influxdb/models" - "github.com/influxdata/influxdb/services/meta" "github.com/influxdata/influxdb/uuid" + "github.com/influxdata/kapacitor/auth" "github.com/influxdata/kapacitor/client/v1" "github.com/influxdata/kapacitor/services/logging" "github.com/influxdata/wlog" @@ -31,10 +33,22 @@ const ( statWriteRequestBytesReceived = "write_req_bytes" // Sum of all bytes in write requests statPointsWrittenOK = "points_written_ok" // Number of points written OK statPointsWrittenFail = "points_written_fail" // Number of points that failed to be written + statAuthFail = "auth_fail" // Number of requests that failed to authenticate ) const BasePath = "/kapacitor/v1" +// AuthenticationMethod defines the type of authentication used. +type AuthenticationMethod int + +// Supported authentication methods. +const ( + UserAuthentication AuthenticationMethod = iota + BearerAuthentication +) + +type AuthorizationHandler func(http.ResponseWriter, *http.Request, auth.User) + type Route struct { Name string Method string @@ -45,15 +59,16 @@ type Route struct { // Handler represents an HTTP handler for the Kapacitor API server. type Handler struct { - methodMux map[string]*ServeMux + methodMux map[string]*ServeMux + requireAuthentication bool - allowGzip bool - Version string + sharedSecret string - MetaClient interface { - Authenticate(username, password string) (ui *meta.UserInfo, err error) - Users() ([]meta.UserInfo, error) - } + allowGzip bool + + Version string + + AuthService auth.Interface PointsWriter interface { WritePoints(database, retentionPolicy string, consistencyLevel models.ConsistencyLevel, points []models.Point) error @@ -76,10 +91,20 @@ type Handler struct { } // NewHandler returns a new instance of handler with routes. -func NewHandler(requireAuthentication, loggingEnabled, writeTrace, allowGzip bool, statMap *expvar.Map, l *log.Logger, li logging.Interface) *Handler { +func NewHandler( + requireAuthentication, + loggingEnabled, + writeTrace, + allowGzip bool, + statMap *expvar.Map, + l *log.Logger, + li logging.Interface, + sharedSecret string, +) *Handler { h := &Handler{ methodMux: make(map[string]*ServeMux), requireAuthentication: requireAuthentication, + sharedSecret: sharedSecret, allowGzip: allowGzip, logger: l, writeTrace: writeTrace, @@ -243,13 +268,17 @@ func (h *Handler) addRawRoutes(routes []Route) error { // Add a route without prepending the BasePath func (h *Handler) addRawRoute(r Route) error { var handler http.Handler - // If it's a handler func that requires authorization, wrap it in authorization - if hf, ok := r.HandlerFunc.(func(http.ResponseWriter, *http.Request, *meta.UserInfo)); ok { - handler = authenticate(hf, h, h.requireAuthentication) + // If it's a handler func that requires special authorization, wrap it in authentication only. + if hf, ok := r.HandlerFunc.(func(http.ResponseWriter, *http.Request, auth.User)); ok { + handler = authenticate(authorizeForward(hf), h, h.requireAuthentication) } - // This is a normal handler signature and does not require authorization + + // This is a normal handler signature so perform standard authentication/authorization. if hf, ok := r.HandlerFunc.(func(http.ResponseWriter, *http.Request)); ok { - handler = http.HandlerFunc(hf) + handler = authenticate(authorize(hf), h, h.requireAuthentication) + } + if handler == nil { + return errors.New("route does not have valid handler function") } // Set basic handlers for all requests @@ -362,7 +391,7 @@ func (h *Handler) servePing(w http.ResponseWriter, r *http.Request) { w.WriteHeader(http.StatusNoContent) } -func (h *Handler) serveWrite(w http.ResponseWriter, r *http.Request, user *meta.UserInfo) { +func (h *Handler) serveWrite(w http.ResponseWriter, r *http.Request, user auth.User) { h.statMap.Add(statWriteRequest, 1) // Handle gzip decoding of the body @@ -394,7 +423,7 @@ func (h *Handler) serveWrite(w http.ResponseWriter, r *http.Request, user *meta. } // serveWriteLine receives incoming series data in line protocol format and writes it to the database. -func (h *Handler) serveWriteLine(w http.ResponseWriter, r *http.Request, body []byte, user *meta.UserInfo) { +func (h *Handler) serveWriteLine(w http.ResponseWriter, r *http.Request, body []byte, user auth.User) { precision := r.FormValue("precision") if precision == "" { precision = "n" @@ -416,13 +445,12 @@ func (h *Handler) serveWriteLine(w http.ResponseWriter, r *http.Request, body [] return } - if h.requireAuthentication && user == nil { - h.writeError(w, influxql.Result{Err: fmt.Errorf("user is required to write to database %q", database)}, http.StatusUnauthorized) - return + action := auth.Action{ + Resource: auth.DatabaseResource(database), + Privilege: auth.WritePrivilege, } - - if h.requireAuthentication && !user.Authorize(influxql.WritePrivilege, database) { - h.writeError(w, influxql.Result{Err: fmt.Errorf("%q user is not authorized to write to database %q", user.Name, database)}, http.StatusUnauthorized) + if err := user.AuthorizeAction(action); err != nil { + h.writeError(w, influxql.Result{Err: fmt.Errorf("%q user is not authorized to write to database %q", user.Name(), database)}, http.StatusUnauthorized) return } @@ -505,37 +533,193 @@ func resultError(w http.ResponseWriter, result influxql.Result, code int) { // Filters and filter helpers -// parseCredentials returns the username and password encoded in -// a request. The credentials may be present as URL query params, or as -// a Basic Authentication header. -// as params: http://127.0.0.1/query?u=username&p=password -// as basic auth: http://username:password@127.0.0.1 -func parseCredentials(r *http.Request) (string, string, error) { - q := r.URL.Query() - - if u, p := q.Get("u"), q.Get("p"); u != "" && p != "" { - return u, p, nil - } - if u, p, ok := r.BasicAuth(); ok { - return u, p, nil - } - return "", "", fmt.Errorf("unable to parse Basic Auth credentials") -} - // authenticate wraps a handler and ensures that if user credentials are passed in // an attempt is made to authenticate that user. If authentication fails, an error is returned. -// NOT IMPLEMENTED YET -func authenticate(inner func(http.ResponseWriter, *http.Request, *meta.UserInfo), h *Handler, requireAuthentication bool) http.Handler { +func authenticate(inner AuthorizationHandler, h *Handler, requireAuthentication bool) http.Handler { return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { // Return early if we are not authenticating if !requireAuthentication { - inner(w, r, nil) + inner(w, r, auth.AdminUser) return } - panic("Authentication not implemented") + + var user auth.User + + creds, err := parseCredentials(r) + if err != nil { + h.statMap.Add(statAuthFail, 1) + HttpError(w, err.Error(), false, http.StatusUnauthorized) + return + } + + switch creds.Method { + case UserAuthentication: + if creds.Username == "" { + h.statMap.Add(statAuthFail, 1) + HttpError(w, "username required", false, http.StatusUnauthorized) + return + } + + user, err = h.AuthService.Authenticate(creds.Username, creds.Password) + if err != nil { + h.statMap.Add(statAuthFail, 1) + HttpError(w, "authorization failed", false, http.StatusUnauthorized) + return + } + case BearerAuthentication: + keyLookupFn := func(token *jwt.Token) (interface{}, error) { + // Check for expected signing method. + if _, ok := token.Method.(*jwt.SigningMethodHMAC); !ok { + return nil, fmt.Errorf("unexpected signing method: %v", token.Header["alg"]) + } + return []byte(h.sharedSecret), nil + } + + // Parse and validate the token. + token, err := jwt.Parse(creds.Token, keyLookupFn) + if err != nil { + HttpError(w, fmt.Sprintf("invalid token: %s", err.Error()), false, http.StatusUnauthorized) + return + } else if !token.Valid { + HttpError(w, "invalid token", false, http.StatusUnauthorized) + return + } + claims, ok := token.Claims.(jwt.MapClaims) + if !ok { + // This should not be possible, but just in case. + HttpError(w, "invalid claims type", false, http.StatusUnauthorized) + return + } + + // The exp claim is validated internally as long as it exists and is non-zero. + // Make sure a non-zero expiration was set on the token. + if exp, ok := claims["exp"].(float64); !ok || exp <= 0.0 { + HttpError(w, "token expiration required", false, http.StatusUnauthorized) + return + } + + // Get the username from the token. + username, ok := claims["username"].(string) + if !ok { + HttpError(w, "username in token must be a string", false, http.StatusUnauthorized) + return + } else if username == "" { + HttpError(w, "token must contain a username", false, http.StatusUnauthorized) + return + } + + if user, err = h.AuthService.User(username); err != nil { + HttpError(w, err.Error(), false, http.StatusUnauthorized) + return + } + default: + HttpError(w, "unsupported authentication", false, http.StatusUnauthorized) + } + inner(w, r, user) }) } +// Map an HTTP method to an auth.Privilege. +func requiredPrivilegeForHTTPMethod(method string) (auth.Privilege, error) { + switch m := strings.ToUpper(method); m { + case "HEAD", "OPTIONS": + return auth.NoPrivileges, nil + case "GET": + return auth.ReadPrivilege, nil + case "POST", "PATCH": + return auth.WritePrivilege, nil + case "DELETE": + return auth.DeletePrivilege, nil + default: + return auth.AllPrivileges, fmt.Errorf("unknown method %q", m) + } +} + +// Check if user is authorized to perform request. +func authorizeRequest(r *http.Request, user auth.User) error { + // Now that we have a user authorize the request + rp, err := requiredPrivilegeForHTTPMethod(r.Method) + if err != nil { + return err + } + action := auth.Action{ + Resource: strings.TrimPrefix(r.URL.Path, BasePath), + Privilege: rp, + } + return user.AuthorizeAction(action) +} + +// Authorize the request and call normal inner handler. +func authorize(inner http.HandlerFunc) AuthorizationHandler { + return func(w http.ResponseWriter, r *http.Request, user auth.User) { + if err := authorizeRequest(r, user); err != nil { + HttpError(w, err.Error(), false, http.StatusForbidden) + return + } + inner(w, r) + } +} + +// Authorize the request and forward user to inner handler. +func authorizeForward(inner AuthorizationHandler) AuthorizationHandler { + return func(w http.ResponseWriter, r *http.Request, user auth.User) { + if err := authorizeRequest(r, user); err != nil { + HttpError(w, err.Error(), false, http.StatusForbidden) + return + } + inner(w, r, user) + } +} + +type credentials struct { + Method AuthenticationMethod + Username string + Password string + Token string +} + +// parseCredentials parses a request and returns the authentication credentials. +// The credentials may be present as URL query params, or as a Basic +// Authentication header. +// As params: http://127.0.0.1/query?u=username&p=password +// As basic auth: http://username:password@127.0.0.1 +// As Bearer token in Authorization header: Bearer +func parseCredentials(r *http.Request) (credentials, error) { + q := r.URL.Query() + + // Check for the HTTP Authorization header. + if s := r.Header.Get("Authorization"); s != "" { + // Check for Bearer token. + strs := strings.Split(s, " ") + if len(strs) == 2 && strs[0] == "Bearer" { + return credentials{ + Method: BearerAuthentication, + Token: strs[1], + }, nil + } + + // Check for basic auth. + if u, p, ok := r.BasicAuth(); ok { + return credentials{ + Method: UserAuthentication, + Username: u, + Password: p, + }, nil + } + } + + // Check for username and password in URL params. + if u, p := q.Get("u"), q.Get("p"); u != "" && p != "" { + return credentials{ + Method: UserAuthentication, + Username: u, + Password: p, + }, nil + } + + return credentials{}, fmt.Errorf("unable to parse authentication credentials") +} + type gzipResponseWriter struct { io.Writer http.ResponseWriter diff --git a/services/httpd/handler_test.go b/services/httpd/handler_test.go new file mode 100644 index 000000000..80e137763 --- /dev/null +++ b/services/httpd/handler_test.go @@ -0,0 +1,100 @@ +package httpd + +import ( + "errors" + "testing" + + "github.com/influxdata/kapacitor/auth" +) + +func Test_RequiredPrilegeForHTTPMethod(t *testing.T) { + testCases := []struct { + m string + rp auth.Privilege + err error + }{ + { + m: "GET", + rp: auth.ReadPrivilege, + err: nil, + }, + { + m: "get", + rp: auth.ReadPrivilege, + err: nil, + }, + { + m: "HEAD", + rp: auth.NoPrivileges, + err: nil, + }, + { + m: "head", + rp: auth.NoPrivileges, + err: nil, + }, + { + m: "OPTIONS", + rp: auth.NoPrivileges, + err: nil, + }, + { + m: "options", + rp: auth.NoPrivileges, + err: nil, + }, + { + m: "POST", + rp: auth.WritePrivilege, + err: nil, + }, + { + m: "post", + rp: auth.WritePrivilege, + err: nil, + }, + { + m: "PATCH", + rp: auth.WritePrivilege, + err: nil, + }, + { + m: "patch", + rp: auth.WritePrivilege, + err: nil, + }, + { + m: "DELETE", + rp: auth.DeletePrivilege, + err: nil, + }, + { + m: "delete", + rp: auth.DeletePrivilege, + err: nil, + }, + { + m: "PUT", + err: errors.New(`unknown method "PUT"`), + }, + } + + for _, tc := range testCases { + got, err := requiredPrivilegeForHTTPMethod(tc.m) + if err != nil { + if tc.err == nil { + t.Errorf("unexpected error: got %v", err) + } else if tc.err.Error() != err.Error() { + t.Errorf("unexpected error message: got %q exp %q", err.Error(), tc.err.Error()) + } + } else { + if tc.err != nil { + t.Errorf("expected error: %q got nil", tc.err.Error()) + continue + } + if got != tc.rp { + t.Errorf("unexpected required privilege: got %v exp %v", got, tc.rp) + } + } + } +} diff --git a/services/httpd/service.go b/services/httpd/service.go index 3e55ba560..60107f267 100644 --- a/services/httpd/service.go +++ b/services/httpd/service.go @@ -54,6 +54,7 @@ func NewService(c Config, l *log.Logger, li logging.Interface) *Service { statMap, l, li, + c.SharedSecret, ), logger: l, } diff --git a/services/logging/service.go b/services/logging/service.go index 9cc3b2197..2850593cf 100644 --- a/services/logging/service.go +++ b/services/logging/service.go @@ -9,12 +9,23 @@ import ( "github.com/influxdata/wlog" ) +type Level wlog.Level + +const ( + _ Level = iota + DEBUG + INFO + WARN + ERROR + OFF +) + // Interface for creating new loggers type Interface interface { NewLogger(prefix string, flag int) *log.Logger NewRawLogger(prefix string, flag int) *log.Logger - NewStaticLevelLogger(prefix string, flag int, l wlog.Level) *log.Logger - NewStaticLevelWriter(l wlog.Level) io.Writer + NewStaticLevelLogger(prefix string, flag int, l Level) *log.Logger + NewStaticLevelWriter(l Level) io.Writer } type Service struct { @@ -73,15 +84,17 @@ func (s *Service) Close() error { func (s *Service) NewLogger(prefix string, flag int) *log.Logger { return wlog.New(s.f, prefix, flag) } + func (s *Service) NewRawLogger(prefix string, flag int) *log.Logger { return log.New(s.f, prefix, flag) } -func (s *Service) NewStaticLevelLogger(prefix string, flag int, l wlog.Level) *log.Logger { - return log.New(wlog.NewStaticLevelWriter(s.f, l), prefix, flag) + +func (s *Service) NewStaticLevelLogger(prefix string, flag int, l Level) *log.Logger { + return log.New(wlog.NewStaticLevelWriter(s.f, wlog.Level(l)), prefix, flag) } -func (s *Service) NewStaticLevelWriter(l wlog.Level) io.Writer { - return wlog.NewStaticLevelWriter(s.f, l) +func (s *Service) NewStaticLevelWriter(l Level) io.Writer { + return wlog.NewStaticLevelWriter(s.f, wlog.Level(l)) } type nopCloser struct { diff --git a/services/noauth/service.go b/services/noauth/service.go new file mode 100644 index 000000000..b41e39156 --- /dev/null +++ b/services/noauth/service.go @@ -0,0 +1,39 @@ +package noauth + +import ( + "log" + + "github.com/influxdata/kapacitor/auth" +) + +// Provide an implentation of an Authentication service. +// NOTE: This service provides no real authentication but rather +// returns admin users for all requests. +type Service struct { + logger *log.Logger +} + +func NewService(l *log.Logger) *Service { + return &Service{ + logger: l, + } +} + +func (s *Service) Open() error { + return nil +} +func (s *Service) Close() error { + return nil +} + +// Return a user will all privileges and given username. +// NOTE: Password is ignored as no real authentication is performed. +func (s *Service) Authenticate(username, password string) (auth.User, error) { + return s.User(username) +} + +// Return a user will all privileges and given username. +func (s *Service) User(username string) (auth.User, error) { + s.logger.Println("W! using noauth auth backend. Faked authentication for user", username) + return auth.NewUser(username, nil, true, nil), nil +} diff --git a/vendor.list b/vendor.list index a0eacca22..99c325481 100644 --- a/vendor.list +++ b/vendor.list @@ -1,6 +1,7 @@ github.com/boltdb/bolt github.com/BurntSushi/toml github.com/cenkalti/backoff +github.com/dgrijalva/jwt-go v3.0.0 github.com/dustin/go-humanize github.com/gogo/protobuf github.com/golang/protobuf diff --git a/vendor/github.com/dgrijalva/jwt-go/.gitignore b/vendor/github.com/dgrijalva/jwt-go/.gitignore new file mode 100644 index 000000000..80bed650e --- /dev/null +++ b/vendor/github.com/dgrijalva/jwt-go/.gitignore @@ -0,0 +1,4 @@ +.DS_Store +bin + + diff --git a/vendor/github.com/dgrijalva/jwt-go/.gitrepo b/vendor/github.com/dgrijalva/jwt-go/.gitrepo new file mode 100644 index 000000000..7bb83b2c0 --- /dev/null +++ b/vendor/github.com/dgrijalva/jwt-go/.gitrepo @@ -0,0 +1,11 @@ +; DO NOT EDIT (unless you know what you are doing) +; +; This subdirectory is a git "subrepo", and this file is maintained by the +; git-subrepo command. See https://github.com/git-commands/git-subrepo#readme +; +[subrepo] + remote = https://github.com/dgrijalva/jwt-go.git + branch = v3.0.0 + commit = d2709f9f1f31ebcda9651b03077758c1f3a0018c + parent = 592409c1c2399e73ff2e8335e0c4b90561211c5f + cmdver = 0.3.0 diff --git a/vendor/github.com/dgrijalva/jwt-go/.travis.yml b/vendor/github.com/dgrijalva/jwt-go/.travis.yml new file mode 100644 index 000000000..bde823d8a --- /dev/null +++ b/vendor/github.com/dgrijalva/jwt-go/.travis.yml @@ -0,0 +1,8 @@ +language: go + +go: + - 1.3 + - 1.4 + - 1.5 + - 1.6 + - tip diff --git a/vendor/github.com/dgrijalva/jwt-go/LICENSE b/vendor/github.com/dgrijalva/jwt-go/LICENSE new file mode 100644 index 000000000..df83a9c2f --- /dev/null +++ b/vendor/github.com/dgrijalva/jwt-go/LICENSE @@ -0,0 +1,8 @@ +Copyright (c) 2012 Dave Grijalva + +Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + diff --git a/vendor/github.com/dgrijalva/jwt-go/MIGRATION_GUIDE.md b/vendor/github.com/dgrijalva/jwt-go/MIGRATION_GUIDE.md new file mode 100644 index 000000000..fd62e9490 --- /dev/null +++ b/vendor/github.com/dgrijalva/jwt-go/MIGRATION_GUIDE.md @@ -0,0 +1,96 @@ +## Migration Guide from v2 -> v3 + +Version 3 adds several new, frequently requested features. To do so, it introduces a few breaking changes. We've worked to keep these as minimal as possible. This guide explains the breaking changes and how you can quickly update your code. + +### `Token.Claims` is now an interface type + +The most requested feature from the 2.0 verison of this library was the ability to provide a custom type to the JSON parser for claims. This was implemented by introducing a new interface, `Claims`, to replace `map[string]interface{}`. We also included two concrete implementations of `Claims`: `MapClaims` and `StandardClaims`. + +`MapClaims` is an alias for `map[string]interface{}` with built in validation behavior. It is the default claims type when using `Parse`. The usage is unchanged except you must type cast the claims property. + +The old example for parsing a token looked like this.. + +```go + if token, err := jwt.Parse(tokenString, keyLookupFunc); err == nil { + fmt.Printf("Token for user %v expires %v", token.Claims["user"], token.Claims["exp"]) + } +``` + +is now directly mapped to... + +```go + if token, err := jwt.Parse(tokenString, keyLookupFunc); err == nil { + claims := token.Claims.(jwt.MapClaims) + fmt.Printf("Token for user %v expires %v", claims["user"], claims["exp"]) + } +``` + +`StandardClaims` is designed to be embedded in your custom type. You can supply a custom claims type with the new `ParseWithClaims` function. Here's an example of using a custom claims type. + +```go + type MyCustomClaims struct { + User string + *StandardClaims + } + + if token, err := jwt.ParseWithClaims(tokenString, &MyCustomClaims{}, keyLookupFunc); err == nil { + claims := token.Claims.(*MyCustomClaims) + fmt.Printf("Token for user %v expires %v", claims.User, claims.StandardClaims.ExpiresAt) + } +``` + +### `ParseFromRequest` has been moved + +To keep this library focused on the tokens without becoming overburdened with complex request processing logic, `ParseFromRequest` and its new companion `ParseFromRequestWithClaims` have been moved to a subpackage, `request`. The method signatues have also been augmented to receive a new argument: `Extractor`. + +`Extractors` do the work of picking the token string out of a request. The interface is simple and composable. + +This simple parsing example: + +```go + if token, err := jwt.ParseFromRequest(tokenString, req, keyLookupFunc); err == nil { + fmt.Printf("Token for user %v expires %v", token.Claims["user"], token.Claims["exp"]) + } +``` + +is directly mapped to: + +```go + if token, err := request.ParseFromRequest(tokenString, request.OAuth2Extractor, req, keyLookupFunc); err == nil { + fmt.Printf("Token for user %v expires %v", token.Claims["user"], token.Claims["exp"]) + } +``` + +There are several concrete `Extractor` types provided for your convenience: + +* `HeaderExtractor` will search a list of headers until one contains content. +* `ArgumentExtractor` will search a list of keys in request query and form arguments until one contains content. +* `MultiExtractor` will try a list of `Extractors` in order until one returns content. +* `AuthorizationHeaderExtractor` will look in the `Authorization` header for a `Bearer` token. +* `OAuth2Extractor` searches the places an OAuth2 token would be specified (per the spec): `Authorization` header and `access_token` argument +* `PostExtractionFilter` wraps an `Extractor`, allowing you to process the content before it's parsed. A simple example is stripping the `Bearer ` text from a header + + +### RSA signing methods no longer accept `[]byte` keys + +Due to a [critical vulnerability](https://auth0.com/blog/2015/03/31/critical-vulnerabilities-in-json-web-token-libraries/), we've decided the convenience of accepting `[]byte` instead of `rsa.PublicKey` or `rsa.PrivateKey` isn't worth the risk of misuse. + +To replace this behavior, we've added two helper methods: `ParseRSAPrivateKeyFromPEM(key []byte) (*rsa.PrivateKey, error)` and `ParseRSAPublicKeyFromPEM(key []byte) (*rsa.PublicKey, error)`. These are just simple helpers for unpacking PEM encoded PKCS1 and PKCS8 keys. If your keys are encoded any other way, all you need to do is convert them to the `crypto/rsa` package's types. + +```go + func keyLookupFunc(*Token) (interface{}, error) { + // Don't forget to validate the alg is what you expect: + if _, ok := token.Method.(*jwt.SigningMethodRSA); !ok { + return nil, fmt.Errorf("Unexpected signing method: %v", token.Header["alg"]) + } + + // Look up key + key, err := lookupPublicKey(token.Header["kid"]) + if err != nil { + return nil, err + } + + // Unpack key from PEM encoded PKCS8 + return jwt.ParseRSAPublicKeyFromPEM(key) + } +``` diff --git a/vendor/github.com/dgrijalva/jwt-go/README.md b/vendor/github.com/dgrijalva/jwt-go/README.md new file mode 100644 index 000000000..00f613672 --- /dev/null +++ b/vendor/github.com/dgrijalva/jwt-go/README.md @@ -0,0 +1,85 @@ +A [go](http://www.golang.org) (or 'golang' for search engine friendliness) implementation of [JSON Web Tokens](http://self-issued.info/docs/draft-ietf-oauth-json-web-token.html) + +[![Build Status](https://travis-ci.org/dgrijalva/jwt-go.svg?branch=master)](https://travis-ci.org/dgrijalva/jwt-go) + +**BREAKING CHANGES:*** Version 3.0.0 is here. It includes _a lot_ of changes including a few that break the API. We've tried to break as few things as possible, so there should just be a few type signature changes. A full list of breaking changes is available in `VERSION_HISTORY.md`. See `MIGRATION_GUIDE.md` for more information on updating your code. + +**NOTICE:** A vulnerability in JWT was [recently published](https://auth0.com/blog/2015/03/31/critical-vulnerabilities-in-json-web-token-libraries/). As this library doesn't force users to validate the `alg` is what they expected, it's possible your usage is effected. There will be an update soon to remedy this, and it will likey require backwards-incompatible changes to the API. In the short term, please make sure your implementation verifies the `alg` is what you expect. + + +## What the heck is a JWT? + +JWT.io has [a great introduction](https://jwt.io/introduction) to JSON Web Tokens. + +In short, it's a signed JSON object that does something useful (for example, authentication). It's commonly used for `Bearer` tokens in Oauth 2. A token is made of three parts, separated by `.`'s. The first two parts are JSON objects, that have been [base64url](http://tools.ietf.org/html/rfc4648) encoded. The last part is the signature, encoded the same way. + +The first part is called the header. It contains the necessary information for verifying the last part, the signature. For example, which encryption method was used for signing and what key was used. + +The part in the middle is the interesting bit. It's called the Claims and contains the actual stuff you care about. Refer to [the RFC](http://self-issued.info/docs/draft-jones-json-web-token.html) for information about reserved keys and the proper way to add your own. + +## What's in the box? + +This library supports the parsing and verification as well as the generation and signing of JWTs. Current supported signing algorithms are HMAC SHA, RSA, RSA-PSS, and ECDSA, though hooks are present for adding your own. + +## Examples + +See [the project documentation](https://godoc.org/github.com/dgrijalva/jwt-go) for examples of usage: + +* [Simple example of parsing and validating a token](https://godoc.org/github.com/dgrijalva/jwt-go#example_Parse_hmac) +* [Simple example of building and signing a token](https://godoc.org/github.com/dgrijalva/jwt-go#example_New_hmac) +* [Directory of Examples](https://godoc.org/github.com/dgrijalva/jwt-go#pkg-examples) + +## Extensions + +This library publishes all the necessary components for adding your own signing methods. Simply implement the `SigningMethod` interface and register a factory method using `RegisterSigningMethod`. + +Here's an example of an extension that integrates with the Google App Engine signing tools: https://github.com/someone1/gcp-jwt-go + +## Compliance + +This library was last reviewed to comply with [RTF 7519](http://www.rfc-editor.org/info/rfc7519) dated May 2015 with a few notable differences: + +* In order to protect against accidental use of [Unsecured JWTs](http://self-issued.info/docs/draft-ietf-oauth-json-web-token.html#UnsecuredJWT), tokens using `alg=none` will only be accepted if the constant `jwt.UnsafeAllowNoneSignatureType` is provided as the key. + +## Project Status & Versioning + +This library is considered production ready. Feedback and feature requests are appreciated. The API should be considered stable. There should be very few backwards-incompatible changes outside of major version updates (and only with good reason). + +This project uses [Semantic Versioning 2.0.0](http://semver.org). Accepted pull requests will land on `master`. Periodically, versions will be tagged from `master`. You can find all the releases on [the project releases page](https://github.com/dgrijalva/jwt-go/releases). + +While we try to make it obvious when we make breaking changes, there isn't a great mechanism for pushing announcements out to users. You may want to use this alternative package include: `gopkg.in/dgrijalva/jwt-go.v2`. It will do the right thing WRT semantic versioning. + +## Usage Tips + +### Signing vs Encryption + +A token is simply a JSON object that is signed by its author. this tells you exactly two things about the data: + +* The author of the token was in the possession of the signing secret +* The data has not been modified since it was signed + +It's important to know that JWT does not provide encryption, which means anyone who has access to the token can read its contents. If you need to protect (encrypt) the data, there is a companion spec, `JWE`, that provides this functionality. JWE is currently outside the scope of this library. + +### Choosing a Signing Method + +There are several signing methods available, and you should probably take the time to learn about the various options before choosing one. The principal design decision is most likely going to be symmetric vs asymmetric. + +Symmetric signing methods, such as HSA, use only a single secret. This is probably the simplest signing method to use since any `[]byte` can be used as a valid secret. They are also slightly computationally faster to use, though this rarely is enough to matter. Symmetric signing methods work the best when both producers and consumers of tokens are trusted, or even the same system. Since the same secret is used to both sign and validate tokens, you can't easily distribute the key for validation. + +Asymmetric signing methods, such as RSA, use different keys for signing and verifying tokens. This makes it possible to produce tokens with a private key, and allow any consumer to access the public key for verification. + +### JWT and OAuth + +It's worth mentioning that OAuth and JWT are not the same thing. A JWT token is simply a signed JSON object. It can be used anywhere such a thing is useful. There is some confusion, though, as JWT is the most common type of bearer token used in OAuth2 authentication. + +Without going too far down the rabbit hole, here's a description of the interaction of these technologies: + +* OAuth is a protocol for allowing an identity provider to be separate from the service a user is logging in to. For example, whenever you use Facebook to log into a different service (Yelp, Spotify, etc), you are using OAuth. +* OAuth defines several options for passing around authentication data. One popular method is called a "bearer token". A bearer token is simply a string that _should_ only be held by an authenticated user. Thus, simply presenting this token proves your identity. You can probably derive from here why a JWT might make a good bearer token. +* Because bearer tokens are used for authentication, it's important they're kept secret. This is why transactions that use bearer tokens typically happen over SSL. + +## More + +Documentation can be found [on godoc.org](http://godoc.org/github.com/dgrijalva/jwt-go). + +The command line utility included in this project (cmd/jwt) provides a straightforward example of token creation and parsing as well as a useful tool for debugging your own integration. You'll also find several implementation examples in to documentation. diff --git a/vendor/github.com/dgrijalva/jwt-go/VERSION_HISTORY.md b/vendor/github.com/dgrijalva/jwt-go/VERSION_HISTORY.md new file mode 100644 index 000000000..b605b4509 --- /dev/null +++ b/vendor/github.com/dgrijalva/jwt-go/VERSION_HISTORY.md @@ -0,0 +1,105 @@ +## `jwt-go` Version History + +#### 3.0.0 + +* **Compatibility Breaking Changes**: See MIGRATION_GUIDE.md for tips on updating your code + * Dropped support for `[]byte` keys when using RSA signing methods. This convenience feature could contribute to security vulnerabilities involving mismatched key types with signing methods. + * `ParseFromRequest` has been moved to `request` subpackage and usage has changed + * The `Claims` property on `Token` is now type `Claims` instead of `map[string]interface{}`. The default value is type `MapClaims`, which is an alias to `map[string]interface{}`. This makes it possible to use a custom type when decoding claims. +* Other Additions and Changes + * Added `Claims` interface type to allow users to decode the claims into a custom type + * Added `ParseWithClaims`, which takes a third argument of type `Claims`. Use this function instead of `Parse` if you have a custom type you'd like to decode into. + * Dramatically improved the functionality and flexibility of `ParseFromRequest`, which is now in the `request` subpackage + * Added `ParseFromRequestWithClaims` which is the `FromRequest` equivalent of `ParseWithClaims` + * Added new interface type `Extractor`, which is used for extracting JWT strings from http requests. Used with `ParseFromRequest` and `ParseFromRequestWithClaims`. + * Added several new, more specific, validation errors to error type bitmask + * Moved examples from README to executable example files + * Signing method registry is now thread safe + * Added new property to `ValidationError`, which contains the raw error returned by calls made by parse/verify (such as those returned by keyfunc or json parser) + +#### 2.7.0 + +This will likely be the last backwards compatible release before 3.0.0, excluding essential bug fixes. + +* Added new option `-show` to the `jwt` command that will just output the decoded token without verifying +* Error text for expired tokens includes how long it's been expired +* Fixed incorrect error returned from `ParseRSAPublicKeyFromPEM` +* Documentation updates + +#### 2.6.0 + +* Exposed inner error within ValidationError +* Fixed validation errors when using UseJSONNumber flag +* Added several unit tests + +#### 2.5.0 + +* Added support for signing method none. You shouldn't use this. The API tries to make this clear. +* Updated/fixed some documentation +* Added more helpful error message when trying to parse tokens that begin with `BEARER ` + +#### 2.4.0 + +* Added new type, Parser, to allow for configuration of various parsing parameters + * You can now specify a list of valid signing methods. Anything outside this set will be rejected. + * You can now opt to use the `json.Number` type instead of `float64` when parsing token JSON +* Added support for [Travis CI](https://travis-ci.org/dgrijalva/jwt-go) +* Fixed some bugs with ECDSA parsing + +#### 2.3.0 + +* Added support for ECDSA signing methods +* Added support for RSA PSS signing methods (requires go v1.4) + +#### 2.2.0 + +* Gracefully handle a `nil` `Keyfunc` being passed to `Parse`. Result will now be the parsed token and an error, instead of a panic. + +#### 2.1.0 + +Backwards compatible API change that was missed in 2.0.0. + +* The `SignedString` method on `Token` now takes `interface{}` instead of `[]byte` + +#### 2.0.0 + +There were two major reasons for breaking backwards compatibility with this update. The first was a refactor required to expand the width of the RSA and HMAC-SHA signing implementations. There will likely be no required code changes to support this change. + +The second update, while unfortunately requiring a small change in integration, is required to open up this library to other signing methods. Not all keys used for all signing methods have a single standard on-disk representation. Requiring `[]byte` as the type for all keys proved too limiting. Additionally, this implementation allows for pre-parsed tokens to be reused, which might matter in an application that parses a high volume of tokens with a small set of keys. Backwards compatibilty has been maintained for passing `[]byte` to the RSA signing methods, but they will also accept `*rsa.PublicKey` and `*rsa.PrivateKey`. + +It is likely the only integration change required here will be to change `func(t *jwt.Token) ([]byte, error)` to `func(t *jwt.Token) (interface{}, error)` when calling `Parse`. + +* **Compatibility Breaking Changes** + * `SigningMethodHS256` is now `*SigningMethodHMAC` instead of `type struct` + * `SigningMethodRS256` is now `*SigningMethodRSA` instead of `type struct` + * `KeyFunc` now returns `interface{}` instead of `[]byte` + * `SigningMethod.Sign` now takes `interface{}` instead of `[]byte` for the key + * `SigningMethod.Verify` now takes `interface{}` instead of `[]byte` for the key +* Renamed type `SigningMethodHS256` to `SigningMethodHMAC`. Specific sizes are now just instances of this type. + * Added public package global `SigningMethodHS256` + * Added public package global `SigningMethodHS384` + * Added public package global `SigningMethodHS512` +* Renamed type `SigningMethodRS256` to `SigningMethodRSA`. Specific sizes are now just instances of this type. + * Added public package global `SigningMethodRS256` + * Added public package global `SigningMethodRS384` + * Added public package global `SigningMethodRS512` +* Moved sample private key for HMAC tests from an inline value to a file on disk. Value is unchanged. +* Refactored the RSA implementation to be easier to read +* Exposed helper methods `ParseRSAPrivateKeyFromPEM` and `ParseRSAPublicKeyFromPEM` + +#### 1.0.2 + +* Fixed bug in parsing public keys from certificates +* Added more tests around the parsing of keys for RS256 +* Code refactoring in RS256 implementation. No functional changes + +#### 1.0.1 + +* Fixed panic if RS256 signing method was passed an invalid key + +#### 1.0.0 + +* First versioned release +* API stabilized +* Supports creating, signing, parsing, and validating JWT tokens +* Supports RS256 and HS256 signing methods \ No newline at end of file diff --git a/vendor/github.com/dgrijalva/jwt-go/claims.go b/vendor/github.com/dgrijalva/jwt-go/claims.go new file mode 100644 index 000000000..f0228f02e --- /dev/null +++ b/vendor/github.com/dgrijalva/jwt-go/claims.go @@ -0,0 +1,134 @@ +package jwt + +import ( + "crypto/subtle" + "fmt" + "time" +) + +// For a type to be a Claims object, it must just have a Valid method that determines +// if the token is invalid for any supported reason +type Claims interface { + Valid() error +} + +// Structured version of Claims Section, as referenced at +// https://tools.ietf.org/html/rfc7519#section-4.1 +// See examples for how to use this with your own claim types +type StandardClaims struct { + Audience string `json:"aud,omitempty"` + ExpiresAt int64 `json:"exp,omitempty"` + Id string `json:"jti,omitempty"` + IssuedAt int64 `json:"iat,omitempty"` + Issuer string `json:"iss,omitempty"` + NotBefore int64 `json:"nbf,omitempty"` + Subject string `json:"sub,omitempty"` +} + +// Validates time based claims "exp, iat, nbf". +// There is no accounting for clock skew. +// As well, if any of the above claims are not in the token, it will still +// be considered a valid claim. +func (c StandardClaims) Valid() error { + vErr := new(ValidationError) + now := TimeFunc().Unix() + + // The claims below are optional, by default, so if they are set to the + // default value in Go, let's not fail the verification for them. + if c.VerifyExpiresAt(now, false) == false { + delta := time.Unix(now, 0).Sub(time.Unix(c.ExpiresAt, 0)) + vErr.Inner = fmt.Errorf("token is expired by %v", delta) + vErr.Errors |= ValidationErrorExpired + } + + if c.VerifyIssuedAt(now, false) == false { + vErr.Inner = fmt.Errorf("Token used before issued") + vErr.Errors |= ValidationErrorIssuedAt + } + + if c.VerifyNotBefore(now, false) == false { + vErr.Inner = fmt.Errorf("token is not valid yet") + vErr.Errors |= ValidationErrorNotValidYet + } + + if vErr.valid() { + return nil + } + + return vErr +} + +// Compares the aud claim against cmp. +// If required is false, this method will return true if the value matches or is unset +func (c *StandardClaims) VerifyAudience(cmp string, req bool) bool { + return verifyAud(c.Audience, cmp, req) +} + +// Compares the exp claim against cmp. +// If required is false, this method will return true if the value matches or is unset +func (c *StandardClaims) VerifyExpiresAt(cmp int64, req bool) bool { + return verifyExp(c.ExpiresAt, cmp, req) +} + +// Compares the iat claim against cmp. +// If required is false, this method will return true if the value matches or is unset +func (c *StandardClaims) VerifyIssuedAt(cmp int64, req bool) bool { + return verifyIat(c.IssuedAt, cmp, req) +} + +// Compares the iss claim against cmp. +// If required is false, this method will return true if the value matches or is unset +func (c *StandardClaims) VerifyIssuer(cmp string, req bool) bool { + return verifyIss(c.Issuer, cmp, req) +} + +// Compares the nbf claim against cmp. +// If required is false, this method will return true if the value matches or is unset +func (c *StandardClaims) VerifyNotBefore(cmp int64, req bool) bool { + return verifyNbf(c.NotBefore, cmp, req) +} + +// ----- helpers + +func verifyAud(aud string, cmp string, required bool) bool { + if aud == "" { + return !required + } + if subtle.ConstantTimeCompare([]byte(aud), []byte(cmp)) != 0 { + return true + } else { + return false + } +} + +func verifyExp(exp int64, now int64, required bool) bool { + if exp == 0 { + return !required + } + return now <= exp +} + +func verifyIat(iat int64, now int64, required bool) bool { + if iat == 0 { + return !required + } + return now >= iat +} + +func verifyIss(iss string, cmp string, required bool) bool { + if iss == "" { + return !required + } + if subtle.ConstantTimeCompare([]byte(iss), []byte(cmp)) != 0 { + return true + } else { + return false + } +} + +func verifyNbf(nbf int64, now int64, required bool) bool { + if nbf == 0 { + return !required + } + return now >= nbf +} diff --git a/vendor/github.com/dgrijalva/jwt-go/cmd/jwt/README.md b/vendor/github.com/dgrijalva/jwt-go/cmd/jwt/README.md new file mode 100644 index 000000000..4a68ba40a --- /dev/null +++ b/vendor/github.com/dgrijalva/jwt-go/cmd/jwt/README.md @@ -0,0 +1,13 @@ +`jwt` command-line tool +======================= + +This is a simple tool to sign, verify and show JSON Web Tokens from +the command line. + +The following will create and sign a token, then verify it and output the original claims: + + echo {\"foo\":\"bar\"} | bin/jwt -key test/sample_key -alg RS256 -sign - | bin/jwt -key test/sample_key.pub -verify - + +To simply display a token, use: + + echo $JWT | jwt -show - diff --git a/vendor/github.com/dgrijalva/jwt-go/cmd/jwt/app.go b/vendor/github.com/dgrijalva/jwt-go/cmd/jwt/app.go new file mode 100644 index 000000000..c03711474 --- /dev/null +++ b/vendor/github.com/dgrijalva/jwt-go/cmd/jwt/app.go @@ -0,0 +1,245 @@ +// A useful example app. You can use this to debug your tokens on the command line. +// This is also a great place to look at how you might use this library. +// +// Example usage: +// The following will create and sign a token, then verify it and output the original claims. +// echo {\"foo\":\"bar\"} | bin/jwt -key test/sample_key -alg RS256 -sign - | bin/jwt -key test/sample_key.pub -verify - +package main + +import ( + "encoding/json" + "flag" + "fmt" + "io" + "io/ioutil" + "os" + "regexp" + "strings" + + jwt "github.com/dgrijalva/jwt-go" +) + +var ( + // Options + flagAlg = flag.String("alg", "", "signing algorithm identifier") + flagKey = flag.String("key", "", "path to key file or '-' to read from stdin") + flagCompact = flag.Bool("compact", false, "output compact JSON") + flagDebug = flag.Bool("debug", false, "print out all kinds of debug data") + + // Modes - exactly one of these is required + flagSign = flag.String("sign", "", "path to claims object to sign or '-' to read from stdin") + flagVerify = flag.String("verify", "", "path to JWT token to verify or '-' to read from stdin") + flagShow = flag.String("show", "", "path to JWT file or '-' to read from stdin") +) + +func main() { + // Usage message if you ask for -help or if you mess up inputs. + flag.Usage = func() { + fmt.Fprintf(os.Stderr, "Usage of %s:\n", os.Args[0]) + fmt.Fprintf(os.Stderr, " One of the following flags is required: sign, verify\n") + flag.PrintDefaults() + } + + // Parse command line options + flag.Parse() + + // Do the thing. If something goes wrong, print error to stderr + // and exit with a non-zero status code + if err := start(); err != nil { + fmt.Fprintf(os.Stderr, "Error: %v\n", err) + os.Exit(1) + } +} + +// Figure out which thing to do and then do that +func start() error { + if *flagSign != "" { + return signToken() + } else if *flagVerify != "" { + return verifyToken() + } else if *flagShow != "" { + return showToken() + } else { + flag.Usage() + return fmt.Errorf("None of the required flags are present. What do you want me to do?") + } +} + +// Helper func: Read input from specified file or stdin +func loadData(p string) ([]byte, error) { + if p == "" { + return nil, fmt.Errorf("No path specified") + } + + var rdr io.Reader + if p == "-" { + rdr = os.Stdin + } else { + if f, err := os.Open(p); err == nil { + rdr = f + defer f.Close() + } else { + return nil, err + } + } + return ioutil.ReadAll(rdr) +} + +// Print a json object in accordance with the prophecy (or the command line options) +func printJSON(j interface{}) error { + var out []byte + var err error + + if *flagCompact == false { + out, err = json.MarshalIndent(j, "", " ") + } else { + out, err = json.Marshal(j) + } + + if err == nil { + fmt.Println(string(out)) + } + + return err +} + +// Verify a token and output the claims. This is a great example +// of how to verify and view a token. +func verifyToken() error { + // get the token + tokData, err := loadData(*flagVerify) + if err != nil { + return fmt.Errorf("Couldn't read token: %v", err) + } + + // trim possible whitespace from token + tokData = regexp.MustCompile(`\s*$`).ReplaceAll(tokData, []byte{}) + if *flagDebug { + fmt.Fprintf(os.Stderr, "Token len: %v bytes\n", len(tokData)) + } + + // Parse the token. Load the key from command line option + token, err := jwt.Parse(string(tokData), func(t *jwt.Token) (interface{}, error) { + data, err := loadData(*flagKey) + if err != nil { + return nil, err + } + if isEs() { + return jwt.ParseECPublicKeyFromPEM(data) + } + return data, nil + }) + + // Print some debug data + if *flagDebug && token != nil { + fmt.Fprintf(os.Stderr, "Header:\n%v\n", token.Header) + fmt.Fprintf(os.Stderr, "Claims:\n%v\n", token.Claims) + } + + // Print an error if we can't parse for some reason + if err != nil { + return fmt.Errorf("Couldn't parse token: %v", err) + } + + // Is token invalid? + if !token.Valid { + return fmt.Errorf("Token is invalid") + } + + // Print the token details + if err := printJSON(token.Claims); err != nil { + return fmt.Errorf("Failed to output claims: %v", err) + } + + return nil +} + +// Create, sign, and output a token. This is a great, simple example of +// how to use this library to create and sign a token. +func signToken() error { + // get the token data from command line arguments + tokData, err := loadData(*flagSign) + if err != nil { + return fmt.Errorf("Couldn't read token: %v", err) + } else if *flagDebug { + fmt.Fprintf(os.Stderr, "Token: %v bytes", len(tokData)) + } + + // parse the JSON of the claims + var claims jwt.MapClaims + if err := json.Unmarshal(tokData, &claims); err != nil { + return fmt.Errorf("Couldn't parse claims JSON: %v", err) + } + + // get the key + var key interface{} + key, err = loadData(*flagKey) + if err != nil { + return fmt.Errorf("Couldn't read key: %v", err) + } + + // get the signing alg + alg := jwt.GetSigningMethod(*flagAlg) + if alg == nil { + return fmt.Errorf("Couldn't find signing method: %v", *flagAlg) + } + + // create a new token + token := jwt.NewWithClaims(alg, claims) + + if isEs() { + if k, ok := key.([]byte); !ok { + return fmt.Errorf("Couldn't convert key data to key") + } else { + key, err = jwt.ParseECPrivateKeyFromPEM(k) + if err != nil { + return err + } + } + } + + if out, err := token.SignedString(key); err == nil { + fmt.Println(out) + } else { + return fmt.Errorf("Error signing token: %v", err) + } + + return nil +} + +// showToken pretty-prints the token on the command line. +func showToken() error { + // get the token + tokData, err := loadData(*flagShow) + if err != nil { + return fmt.Errorf("Couldn't read token: %v", err) + } + + // trim possible whitespace from token + tokData = regexp.MustCompile(`\s*$`).ReplaceAll(tokData, []byte{}) + if *flagDebug { + fmt.Fprintf(os.Stderr, "Token len: %v bytes\n", len(tokData)) + } + + token, err := jwt.Parse(string(tokData), nil) + if token == nil { + return fmt.Errorf("malformed token: %v", err) + } + + // Print the token details + fmt.Println("Header:") + if err := printJSON(token.Header); err != nil { + return fmt.Errorf("Failed to output header: %v", err) + } + + fmt.Println("Claims:") + if err := printJSON(token.Claims); err != nil { + return fmt.Errorf("Failed to output claims: %v", err) + } + + return nil +} + +func isEs() bool { + return strings.HasPrefix(*flagAlg, "ES") +} diff --git a/vendor/github.com/dgrijalva/jwt-go/doc.go b/vendor/github.com/dgrijalva/jwt-go/doc.go new file mode 100644 index 000000000..a86dc1a3b --- /dev/null +++ b/vendor/github.com/dgrijalva/jwt-go/doc.go @@ -0,0 +1,4 @@ +// Package jwt is a Go implementation of JSON Web Tokens: http://self-issued.info/docs/draft-jones-json-web-token.html +// +// See README.md for more info. +package jwt diff --git a/vendor/github.com/dgrijalva/jwt-go/ecdsa.go b/vendor/github.com/dgrijalva/jwt-go/ecdsa.go new file mode 100644 index 000000000..2f59a2223 --- /dev/null +++ b/vendor/github.com/dgrijalva/jwt-go/ecdsa.go @@ -0,0 +1,147 @@ +package jwt + +import ( + "crypto" + "crypto/ecdsa" + "crypto/rand" + "errors" + "math/big" +) + +var ( + // Sadly this is missing from crypto/ecdsa compared to crypto/rsa + ErrECDSAVerification = errors.New("crypto/ecdsa: verification error") +) + +// Implements the ECDSA family of signing methods signing methods +type SigningMethodECDSA struct { + Name string + Hash crypto.Hash + KeySize int + CurveBits int +} + +// Specific instances for EC256 and company +var ( + SigningMethodES256 *SigningMethodECDSA + SigningMethodES384 *SigningMethodECDSA + SigningMethodES512 *SigningMethodECDSA +) + +func init() { + // ES256 + SigningMethodES256 = &SigningMethodECDSA{"ES256", crypto.SHA256, 32, 256} + RegisterSigningMethod(SigningMethodES256.Alg(), func() SigningMethod { + return SigningMethodES256 + }) + + // ES384 + SigningMethodES384 = &SigningMethodECDSA{"ES384", crypto.SHA384, 48, 384} + RegisterSigningMethod(SigningMethodES384.Alg(), func() SigningMethod { + return SigningMethodES384 + }) + + // ES512 + SigningMethodES512 = &SigningMethodECDSA{"ES512", crypto.SHA512, 66, 521} + RegisterSigningMethod(SigningMethodES512.Alg(), func() SigningMethod { + return SigningMethodES512 + }) +} + +func (m *SigningMethodECDSA) Alg() string { + return m.Name +} + +// Implements the Verify method from SigningMethod +// For this verify method, key must be an ecdsa.PublicKey struct +func (m *SigningMethodECDSA) Verify(signingString, signature string, key interface{}) error { + var err error + + // Decode the signature + var sig []byte + if sig, err = DecodeSegment(signature); err != nil { + return err + } + + // Get the key + var ecdsaKey *ecdsa.PublicKey + switch k := key.(type) { + case *ecdsa.PublicKey: + ecdsaKey = k + default: + return ErrInvalidKeyType + } + + if len(sig) != 2*m.KeySize { + return ErrECDSAVerification + } + + r := big.NewInt(0).SetBytes(sig[:m.KeySize]) + s := big.NewInt(0).SetBytes(sig[m.KeySize:]) + + // Create hasher + if !m.Hash.Available() { + return ErrHashUnavailable + } + hasher := m.Hash.New() + hasher.Write([]byte(signingString)) + + // Verify the signature + if verifystatus := ecdsa.Verify(ecdsaKey, hasher.Sum(nil), r, s); verifystatus == true { + return nil + } else { + return ErrECDSAVerification + } +} + +// Implements the Sign method from SigningMethod +// For this signing method, key must be an ecdsa.PrivateKey struct +func (m *SigningMethodECDSA) Sign(signingString string, key interface{}) (string, error) { + // Get the key + var ecdsaKey *ecdsa.PrivateKey + switch k := key.(type) { + case *ecdsa.PrivateKey: + ecdsaKey = k + default: + return "", ErrInvalidKeyType + } + + // Create the hasher + if !m.Hash.Available() { + return "", ErrHashUnavailable + } + + hasher := m.Hash.New() + hasher.Write([]byte(signingString)) + + // Sign the string and return r, s + if r, s, err := ecdsa.Sign(rand.Reader, ecdsaKey, hasher.Sum(nil)); err == nil { + curveBits := ecdsaKey.Curve.Params().BitSize + + if m.CurveBits != curveBits { + return "", ErrInvalidKey + } + + keyBytes := curveBits / 8 + if curveBits%8 > 0 { + keyBytes += 1 + } + + // We serialize the outpus (r and s) into big-endian byte arrays and pad + // them with zeros on the left to make sure the sizes work out. Both arrays + // must be keyBytes long, and the output must be 2*keyBytes long. + rBytes := r.Bytes() + rBytesPadded := make([]byte, keyBytes) + copy(rBytesPadded[keyBytes-len(rBytes):], rBytes) + + sBytes := s.Bytes() + sBytesPadded := make([]byte, keyBytes) + copy(sBytesPadded[keyBytes-len(sBytes):], sBytes) + + out := append(rBytesPadded, sBytesPadded...) + + return EncodeSegment(out), nil + } else { + return "", err + } +} diff --git a/vendor/github.com/dgrijalva/jwt-go/ecdsa_test.go b/vendor/github.com/dgrijalva/jwt-go/ecdsa_test.go new file mode 100644 index 000000000..753047b1e --- /dev/null +++ b/vendor/github.com/dgrijalva/jwt-go/ecdsa_test.go @@ -0,0 +1,100 @@ +package jwt_test + +import ( + "crypto/ecdsa" + "io/ioutil" + "strings" + "testing" + + "github.com/dgrijalva/jwt-go" +) + +var ecdsaTestData = []struct { + name string + keys map[string]string + tokenString string + alg string + claims map[string]interface{} + valid bool +}{ + { + "Basic ES256", + map[string]string{"private": "test/ec256-private.pem", "public": "test/ec256-public.pem"}, + "eyJ0eXAiOiJKV1QiLCJhbGciOiJFUzI1NiJ9.eyJmb28iOiJiYXIifQ.feG39E-bn8HXAKhzDZq7yEAPWYDhZlwTn3sePJnU9VrGMmwdXAIEyoOnrjreYlVM_Z4N13eK9-TmMTWyfKJtHQ", + "ES256", + map[string]interface{}{"foo": "bar"}, + true, + }, + { + "Basic ES384", + map[string]string{"private": "test/ec384-private.pem", "public": "test/ec384-public.pem"}, + "eyJ0eXAiOiJKV1QiLCJhbGciOiJFUzM4NCJ9.eyJmb28iOiJiYXIifQ.ngAfKMbJUh0WWubSIYe5GMsA-aHNKwFbJk_wq3lq23aPp8H2anb1rRILIzVR0gUf4a8WzDtrzmiikuPWyCS6CN4-PwdgTk-5nehC7JXqlaBZU05p3toM3nWCwm_LXcld", + "ES384", + map[string]interface{}{"foo": "bar"}, + true, + }, + { + "Basic ES512", + map[string]string{"private": "test/ec512-private.pem", "public": "test/ec512-public.pem"}, + "eyJ0eXAiOiJKV1QiLCJhbGciOiJFUzUxMiJ9.eyJmb28iOiJiYXIifQ.AAU0TvGQOcdg2OvrwY73NHKgfk26UDekh9Prz-L_iWuTBIBqOFCWwwLsRiHB1JOddfKAls5do1W0jR_F30JpVd-6AJeTjGKA4C1A1H6gIKwRY0o_tFDIydZCl_lMBMeG5VNFAjO86-WCSKwc3hqaGkq1MugPRq_qrF9AVbuEB4JPLyL5", + "ES512", + map[string]interface{}{"foo": "bar"}, + true, + }, + { + "basic ES256 invalid: foo => bar", + map[string]string{"private": "test/ec256-private.pem", "public": "test/ec256-public.pem"}, + "eyJhbGciOiJFUzI1NiIsInR5cCI6IkpXVCJ9.eyJmb28iOiJiYXIifQ.MEQCIHoSJnmGlPaVQDqacx_2XlXEhhqtWceVopjomc2PJLtdAiAUTeGPoNYxZw0z8mgOnnIcjoxRuNDVZvybRZF3wR1l8W", + "ES256", + map[string]interface{}{"foo": "bar"}, + false, + }, +} + +func TestECDSAVerify(t *testing.T) { + for _, data := range ecdsaTestData { + var err error + + key, _ := ioutil.ReadFile(data.keys["public"]) + + var ecdsaKey *ecdsa.PublicKey + if ecdsaKey, err = jwt.ParseECPublicKeyFromPEM(key); err != nil { + t.Errorf("Unable to parse ECDSA public key: %v", err) + } + + parts := strings.Split(data.tokenString, ".") + + method := jwt.GetSigningMethod(data.alg) + err = method.Verify(strings.Join(parts[0:2], "."), parts[2], ecdsaKey) + if data.valid && err != nil { + t.Errorf("[%v] Error while verifying key: %v", data.name, err) + } + if !data.valid && err == nil { + t.Errorf("[%v] Invalid key passed validation", data.name) + } + } +} + +func TestECDSASign(t *testing.T) { + for _, data := range ecdsaTestData { + var err error + key, _ := ioutil.ReadFile(data.keys["private"]) + + var ecdsaKey *ecdsa.PrivateKey + if ecdsaKey, err = jwt.ParseECPrivateKeyFromPEM(key); err != nil { + t.Errorf("Unable to parse ECDSA private key: %v", err) + } + + if data.valid { + parts := strings.Split(data.tokenString, ".") + method := jwt.GetSigningMethod(data.alg) + sig, err := method.Sign(strings.Join(parts[0:2], "."), ecdsaKey) + if err != nil { + t.Errorf("[%v] Error signing token: %v", data.name, err) + } + if sig == parts[2] { + t.Errorf("[%v] Identical signatures\nbefore:\n%v\nafter:\n%v", data.name, parts[2], sig) + } + } + } +} diff --git a/vendor/github.com/dgrijalva/jwt-go/ecdsa_utils.go b/vendor/github.com/dgrijalva/jwt-go/ecdsa_utils.go new file mode 100644 index 000000000..d19624b72 --- /dev/null +++ b/vendor/github.com/dgrijalva/jwt-go/ecdsa_utils.go @@ -0,0 +1,67 @@ +package jwt + +import ( + "crypto/ecdsa" + "crypto/x509" + "encoding/pem" + "errors" +) + +var ( + ErrNotECPublicKey = errors.New("Key is not a valid ECDSA public key") + ErrNotECPrivateKey = errors.New("Key is not a valid ECDSA private key") +) + +// Parse PEM encoded Elliptic Curve Private Key Structure +func ParseECPrivateKeyFromPEM(key []byte) (*ecdsa.PrivateKey, error) { + var err error + + // Parse PEM block + var block *pem.Block + if block, _ = pem.Decode(key); block == nil { + return nil, ErrKeyMustBePEMEncoded + } + + // Parse the key + var parsedKey interface{} + if parsedKey, err = x509.ParseECPrivateKey(block.Bytes); err != nil { + return nil, err + } + + var pkey *ecdsa.PrivateKey + var ok bool + if pkey, ok = parsedKey.(*ecdsa.PrivateKey); !ok { + return nil, ErrNotECPrivateKey + } + + return pkey, nil +} + +// Parse PEM encoded PKCS1 or PKCS8 public key +func ParseECPublicKeyFromPEM(key []byte) (*ecdsa.PublicKey, error) { + var err error + + // Parse PEM block + var block *pem.Block + if block, _ = pem.Decode(key); block == nil { + return nil, ErrKeyMustBePEMEncoded + } + + // Parse the key + var parsedKey interface{} + if parsedKey, err = x509.ParsePKIXPublicKey(block.Bytes); err != nil { + if cert, err := x509.ParseCertificate(block.Bytes); err == nil { + parsedKey = cert.PublicKey + } else { + return nil, err + } + } + + var pkey *ecdsa.PublicKey + var ok bool + if pkey, ok = parsedKey.(*ecdsa.PublicKey); !ok { + return nil, ErrNotECPublicKey + } + + return pkey, nil +} diff --git a/vendor/github.com/dgrijalva/jwt-go/errors.go b/vendor/github.com/dgrijalva/jwt-go/errors.go new file mode 100644 index 000000000..662df19d4 --- /dev/null +++ b/vendor/github.com/dgrijalva/jwt-go/errors.go @@ -0,0 +1,63 @@ +package jwt + +import ( + "errors" +) + +// Error constants +var ( + ErrInvalidKey = errors.New("key is invalid") + ErrInvalidKeyType = errors.New("key is of invalid type") + ErrHashUnavailable = errors.New("the requested hash function is unavailable") +) + +// The errors that might occur when parsing and validating a token +const ( + ValidationErrorMalformed uint32 = 1 << iota // Token is malformed + ValidationErrorUnverifiable // Token could not be verified because of signing problems + ValidationErrorSignatureInvalid // Signature validation failed + + // Standard Claim validation errors + ValidationErrorAudience // AUD validation failed + ValidationErrorExpired // EXP validation failed + ValidationErrorIssuedAt // IAT validation failed + ValidationErrorIssuer // ISS validation failed + ValidationErrorNotValidYet // NBF validation failed + ValidationErrorId // JTI validation failed + ValidationErrorClaimsInvalid // Generic claims validation error +) + +// Helper for constructing a ValidationError with a string error message +func NewValidationError(errorText string, errorFlags uint32) *ValidationError { + return &ValidationError{ + text: errorText, + Errors: errorFlags, + } +} + +// The error from Parse if token is not valid +type ValidationError struct { + Inner error // stores the error returned by external dependencies, i.e.: KeyFunc + Errors uint32 // bitfield. see ValidationError... constants + text string // errors that do not have a valid error just have text +} + +// Validation error is an error type +func (e ValidationError) Error() string { + if e.Inner != nil { + return e.Inner.Error() + } else if e.text != "" { + return e.text + } else { + return "token is invalid" + } + return e.Inner.Error() +} + +// No errors +func (e *ValidationError) valid() bool { + if e.Errors > 0 { + return false + } + return true +} diff --git a/vendor/github.com/dgrijalva/jwt-go/example_test.go b/vendor/github.com/dgrijalva/jwt-go/example_test.go new file mode 100644 index 000000000..ae8b788a0 --- /dev/null +++ b/vendor/github.com/dgrijalva/jwt-go/example_test.go @@ -0,0 +1,114 @@ +package jwt_test + +import ( + "fmt" + "github.com/dgrijalva/jwt-go" + "time" +) + +// Example (atypical) using the StandardClaims type by itself to parse a token. +// The StandardClaims type is designed to be embedded into your custom types +// to provide standard validation features. You can use it alone, but there's +// no way to retrieve other fields after parsing. +// See the CustomClaimsType example for intended usage. +func ExampleNewWithClaims_standardClaims() { + mySigningKey := []byte("AllYourBase") + + // Create the Claims + claims := &jwt.StandardClaims{ + ExpiresAt: 15000, + Issuer: "test", + } + + token := jwt.NewWithClaims(jwt.SigningMethodHS256, claims) + ss, err := token.SignedString(mySigningKey) + fmt.Printf("%v %v", ss, err) + //Output: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE1MDAwLCJpc3MiOiJ0ZXN0In0.QsODzZu3lUZMVdhbO76u3Jv02iYCvEHcYVUI1kOWEU0 +} + +// Example creating a token using a custom claims type. The StandardClaim is embedded +// in the custom type to allow for easy encoding, parsing and validation of standard claims. +func ExampleNewWithClaims_customClaimsType() { + mySigningKey := []byte("AllYourBase") + + type MyCustomClaims struct { + Foo string `json:"foo"` + jwt.StandardClaims + } + + // Create the Claims + claims := MyCustomClaims{ + "bar", + jwt.StandardClaims{ + ExpiresAt: 15000, + Issuer: "test", + }, + } + + token := jwt.NewWithClaims(jwt.SigningMethodHS256, claims) + ss, err := token.SignedString(mySigningKey) + fmt.Printf("%v %v", ss, err) + //Output: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJmb28iOiJiYXIiLCJleHAiOjE1MDAwLCJpc3MiOiJ0ZXN0In0.HE7fK0xOQwFEr4WDgRWj4teRPZ6i3GLwD5YCm6Pwu_c +} + +// Example creating a token using a custom claims type. The StandardClaim is embedded +// in the custom type to allow for easy encoding, parsing and validation of standard claims. +func ExampleParseWithClaims_customClaimsType() { + tokenString := "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJmb28iOiJiYXIiLCJleHAiOjE1MDAwLCJpc3MiOiJ0ZXN0In0.HE7fK0xOQwFEr4WDgRWj4teRPZ6i3GLwD5YCm6Pwu_c" + + type MyCustomClaims struct { + Foo string `json:"foo"` + jwt.StandardClaims + } + + // sample token is expired. override time so it parses as valid + at(time.Unix(0, 0), func() { + token, err := jwt.ParseWithClaims(tokenString, &MyCustomClaims{}, func(token *jwt.Token) (interface{}, error) { + return []byte("AllYourBase"), nil + }) + + if claims, ok := token.Claims.(*MyCustomClaims); ok && token.Valid { + fmt.Printf("%v %v", claims.Foo, claims.StandardClaims.ExpiresAt) + } else { + fmt.Println(err) + } + }) + + // Output: bar 15000 +} + +// Override time value for tests. Restore default value after. +func at(t time.Time, f func()) { + jwt.TimeFunc = func() time.Time { + return t + } + f() + jwt.TimeFunc = time.Now +} + +// An example of parsing the error types using bitfield checks +func ExampleParse_errorChecking() { + // Token from another example. This token is expired + var tokenString = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJmb28iOiJiYXIiLCJleHAiOjE1MDAwLCJpc3MiOiJ0ZXN0In0.HE7fK0xOQwFEr4WDgRWj4teRPZ6i3GLwD5YCm6Pwu_c" + + token, err := jwt.Parse(tokenString, func(token *jwt.Token) (interface{}, error) { + return []byte("AllYourBase"), nil + }) + + if token.Valid { + fmt.Println("You look nice today") + } else if ve, ok := err.(*jwt.ValidationError); ok { + if ve.Errors&jwt.ValidationErrorMalformed != 0 { + fmt.Println("That's not even a token") + } else if ve.Errors&(jwt.ValidationErrorExpired|jwt.ValidationErrorNotValidYet) != 0 { + // Token is either expired or not active yet + fmt.Println("Timing is everything") + } else { + fmt.Println("Couldn't handle this token:", err) + } + } else { + fmt.Println("Couldn't handle this token:", err) + } + + // Output: Timing is everything +} diff --git a/vendor/github.com/dgrijalva/jwt-go/hmac.go b/vendor/github.com/dgrijalva/jwt-go/hmac.go new file mode 100644 index 000000000..c22991925 --- /dev/null +++ b/vendor/github.com/dgrijalva/jwt-go/hmac.go @@ -0,0 +1,94 @@ +package jwt + +import ( + "crypto" + "crypto/hmac" + "errors" +) + +// Implements the HMAC-SHA family of signing methods signing methods +type SigningMethodHMAC struct { + Name string + Hash crypto.Hash +} + +// Specific instances for HS256 and company +var ( + SigningMethodHS256 *SigningMethodHMAC + SigningMethodHS384 *SigningMethodHMAC + SigningMethodHS512 *SigningMethodHMAC + ErrSignatureInvalid = errors.New("signature is invalid") +) + +func init() { + // HS256 + SigningMethodHS256 = &SigningMethodHMAC{"HS256", crypto.SHA256} + RegisterSigningMethod(SigningMethodHS256.Alg(), func() SigningMethod { + return SigningMethodHS256 + }) + + // HS384 + SigningMethodHS384 = &SigningMethodHMAC{"HS384", crypto.SHA384} + RegisterSigningMethod(SigningMethodHS384.Alg(), func() SigningMethod { + return SigningMethodHS384 + }) + + // HS512 + SigningMethodHS512 = &SigningMethodHMAC{"HS512", crypto.SHA512} + RegisterSigningMethod(SigningMethodHS512.Alg(), func() SigningMethod { + return SigningMethodHS512 + }) +} + +func (m *SigningMethodHMAC) Alg() string { + return m.Name +} + +// Verify the signature of HSXXX tokens. Returns nil if the signature is valid. +func (m *SigningMethodHMAC) Verify(signingString, signature string, key interface{}) error { + // Verify the key is the right type + keyBytes, ok := key.([]byte) + if !ok { + return ErrInvalidKeyType + } + + // Decode signature, for comparison + sig, err := DecodeSegment(signature) + if err != nil { + return err + } + + // Can we use the specified hashing method? + if !m.Hash.Available() { + return ErrHashUnavailable + } + + // This signing method is symmetric, so we validate the signature + // by reproducing the signature from the signing string and key, then + // comparing that against the provided signature. + hasher := hmac.New(m.Hash.New, keyBytes) + hasher.Write([]byte(signingString)) + if !hmac.Equal(sig, hasher.Sum(nil)) { + return ErrSignatureInvalid + } + + // No validation errors. Signature is good. + return nil +} + +// Implements the Sign method from SigningMethod for this signing method. +// Key must be []byte +func (m *SigningMethodHMAC) Sign(signingString string, key interface{}) (string, error) { + if keyBytes, ok := key.([]byte); ok { + if !m.Hash.Available() { + return "", ErrHashUnavailable + } + + hasher := hmac.New(m.Hash.New, keyBytes) + hasher.Write([]byte(signingString)) + + return EncodeSegment(hasher.Sum(nil)), nil + } + + return "", ErrInvalidKey +} diff --git a/vendor/github.com/dgrijalva/jwt-go/hmac_example_test.go b/vendor/github.com/dgrijalva/jwt-go/hmac_example_test.go new file mode 100644 index 000000000..8fb567820 --- /dev/null +++ b/vendor/github.com/dgrijalva/jwt-go/hmac_example_test.go @@ -0,0 +1,64 @@ +package jwt_test + +import ( + "fmt" + "github.com/dgrijalva/jwt-go" + "io/ioutil" + "time" +) + +// For HMAC signing method, the key can be any []byte. It is recommended to generate +// a key using crypto/rand or something equivalent. You need the same key for signing +// and validating. +var hmacSampleSecret []byte + +func init() { + // Load sample key data + if keyData, e := ioutil.ReadFile("test/hmacTestKey"); e == nil { + hmacSampleSecret = keyData + } else { + panic(e) + } +} + +// Example creating, signing, and encoding a JWT token using the HMAC signing method +func ExampleNew_hmac() { + // Create a new token object, specifying signing method and the claims + // you would like it to contain. + token := jwt.NewWithClaims(jwt.SigningMethodHS256, jwt.MapClaims{ + "foo": "bar", + "nbf": time.Date(2015, 10, 10, 12, 0, 0, 0, time.UTC).Unix(), + }) + + // Sign and get the complete encoded token as a string using the secret + tokenString, err := token.SignedString(hmacSampleSecret) + + fmt.Println(tokenString, err) + // Output: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJmb28iOiJiYXIiLCJuYmYiOjE0NDQ0Nzg0MDB9.u1riaD1rW97opCoAuRCTy4w58Br-Zk-bh7vLiRIsrpU +} + +// Example parsing and validating a token using the HMAC signing method +func ExampleParse_hmac() { + // sample token string taken from the New example + tokenString := "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJmb28iOiJiYXIiLCJuYmYiOjE0NDQ0Nzg0MDB9.u1riaD1rW97opCoAuRCTy4w58Br-Zk-bh7vLiRIsrpU" + + // Parse takes the token string and a function for looking up the key. The latter is especially + // useful if you use multiple keys for your application. The standard is to use 'kid' in the + // head of the token to identify which key to use, but the parsed token (head and claims) is provided + // to the callback, providing flexibility. + token, err := jwt.Parse(tokenString, func(token *jwt.Token) (interface{}, error) { + // Don't forget to validate the alg is what you expect: + if _, ok := token.Method.(*jwt.SigningMethodHMAC); !ok { + return nil, fmt.Errorf("Unexpected signing method: %v", token.Header["alg"]) + } + return hmacSampleSecret, nil + }) + + if claims, ok := token.Claims.(jwt.MapClaims); ok && token.Valid { + fmt.Println(claims["foo"], claims["nbf"]) + } else { + fmt.Println(err) + } + + // Output: bar 1.4444784e+09 +} diff --git a/vendor/github.com/dgrijalva/jwt-go/hmac_test.go b/vendor/github.com/dgrijalva/jwt-go/hmac_test.go new file mode 100644 index 000000000..c7e114f4f --- /dev/null +++ b/vendor/github.com/dgrijalva/jwt-go/hmac_test.go @@ -0,0 +1,91 @@ +package jwt_test + +import ( + "github.com/dgrijalva/jwt-go" + "io/ioutil" + "strings" + "testing" +) + +var hmacTestData = []struct { + name string + tokenString string + alg string + claims map[string]interface{} + valid bool +}{ + { + "web sample", + "eyJ0eXAiOiJKV1QiLA0KICJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJqb2UiLA0KICJleHAiOjEzMDA4MTkzODAsDQogImh0dHA6Ly9leGFtcGxlLmNvbS9pc19yb290Ijp0cnVlfQ.dBjftJeZ4CVP-mB92K27uhbUJU1p1r_wW1gFWFOEjXk", + "HS256", + map[string]interface{}{"iss": "joe", "exp": 1300819380, "http://example.com/is_root": true}, + true, + }, + { + "HS384", + "eyJhbGciOiJIUzM4NCIsInR5cCI6IkpXVCJ9.eyJleHAiOjEuMzAwODE5MzhlKzA5LCJodHRwOi8vZXhhbXBsZS5jb20vaXNfcm9vdCI6dHJ1ZSwiaXNzIjoiam9lIn0.KWZEuOD5lbBxZ34g7F-SlVLAQ_r5KApWNWlZIIMyQVz5Zs58a7XdNzj5_0EcNoOy", + "HS384", + map[string]interface{}{"iss": "joe", "exp": 1300819380, "http://example.com/is_root": true}, + true, + }, + { + "HS512", + "eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJleHAiOjEuMzAwODE5MzhlKzA5LCJodHRwOi8vZXhhbXBsZS5jb20vaXNfcm9vdCI6dHJ1ZSwiaXNzIjoiam9lIn0.CN7YijRX6Aw1n2jyI2Id1w90ja-DEMYiWixhYCyHnrZ1VfJRaFQz1bEbjjA5Fn4CLYaUG432dEYmSbS4Saokmw", + "HS512", + map[string]interface{}{"iss": "joe", "exp": 1300819380, "http://example.com/is_root": true}, + true, + }, + { + "web sample: invalid", + "eyJ0eXAiOiJKV1QiLA0KICJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJqb2UiLA0KICJleHAiOjEzMDA4MTkzODAsDQogImh0dHA6Ly9leGFtcGxlLmNvbS9pc19yb290Ijp0cnVlfQ.dBjftJeZ4CVP-mB92K27uhbUJU1p1r_wW1gFWFOEjXo", + "HS256", + map[string]interface{}{"iss": "joe", "exp": 1300819380, "http://example.com/is_root": true}, + false, + }, +} + +// Sample data from http://tools.ietf.org/html/draft-jones-json-web-signature-04#appendix-A.1 +var hmacTestKey, _ = ioutil.ReadFile("test/hmacTestKey") + +func TestHMACVerify(t *testing.T) { + for _, data := range hmacTestData { + parts := strings.Split(data.tokenString, ".") + + method := jwt.GetSigningMethod(data.alg) + err := method.Verify(strings.Join(parts[0:2], "."), parts[2], hmacTestKey) + if data.valid && err != nil { + t.Errorf("[%v] Error while verifying key: %v", data.name, err) + } + if !data.valid && err == nil { + t.Errorf("[%v] Invalid key passed validation", data.name) + } + } +} + +func TestHMACSign(t *testing.T) { + for _, data := range hmacTestData { + if data.valid { + parts := strings.Split(data.tokenString, ".") + method := jwt.GetSigningMethod(data.alg) + sig, err := method.Sign(strings.Join(parts[0:2], "."), hmacTestKey) + if err != nil { + t.Errorf("[%v] Error signing token: %v", data.name, err) + } + if sig != parts[2] { + t.Errorf("[%v] Incorrect signature.\nwas:\n%v\nexpecting:\n%v", data.name, sig, parts[2]) + } + } + } +} + +func BenchmarkHS256Signing(b *testing.B) { + benchmarkSigning(b, jwt.SigningMethodHS256, hmacTestKey) +} + +func BenchmarkHS384Signing(b *testing.B) { + benchmarkSigning(b, jwt.SigningMethodHS384, hmacTestKey) +} + +func BenchmarkHS512Signing(b *testing.B) { + benchmarkSigning(b, jwt.SigningMethodHS512, hmacTestKey) +} diff --git a/vendor/github.com/dgrijalva/jwt-go/http_example_test.go b/vendor/github.com/dgrijalva/jwt-go/http_example_test.go new file mode 100644 index 000000000..82e9c50a4 --- /dev/null +++ b/vendor/github.com/dgrijalva/jwt-go/http_example_test.go @@ -0,0 +1,216 @@ +package jwt_test + +// Example HTTP auth using asymmetric crypto/RSA keys +// This is based on a (now outdated) example at https://gist.github.com/cryptix/45c33ecf0ae54828e63b + +import ( + "bytes" + "crypto/rsa" + "fmt" + "github.com/dgrijalva/jwt-go" + "github.com/dgrijalva/jwt-go/request" + "io" + "io/ioutil" + "log" + "net" + "net/http" + "net/url" + "strings" + "time" +) + +// location of the files used for signing and verification +const ( + privKeyPath = "test/sample_key" // openssl genrsa -out app.rsa keysize + pubKeyPath = "test/sample_key.pub" // openssl rsa -in app.rsa -pubout > app.rsa.pub +) + +var ( + verifyKey *rsa.PublicKey + signKey *rsa.PrivateKey + serverPort int + // storing sample username/password pairs + // don't do this on a real server + users = map[string]string{ + "test": "known", + } +) + +// read the key files before starting http handlers +func init() { + signBytes, err := ioutil.ReadFile(privKeyPath) + fatal(err) + + signKey, err = jwt.ParseRSAPrivateKeyFromPEM(signBytes) + fatal(err) + + verifyBytes, err := ioutil.ReadFile(pubKeyPath) + fatal(err) + + verifyKey, err = jwt.ParseRSAPublicKeyFromPEM(verifyBytes) + fatal(err) + + http.HandleFunc("/authenticate", authHandler) + http.HandleFunc("/restricted", restrictedHandler) + + // Setup listener + listener, err := net.ListenTCP("tcp", &net.TCPAddr{}) + serverPort = listener.Addr().(*net.TCPAddr).Port + + log.Println("Listening...") + go func() { + fatal(http.Serve(listener, nil)) + }() +} + +var start func() + +func fatal(err error) { + if err != nil { + log.Fatal(err) + } +} + +// Define some custom types were going to use within our tokens +type CustomerInfo struct { + Name string + Kind string +} + +type CustomClaimsExample struct { + *jwt.StandardClaims + TokenType string + CustomerInfo +} + +func Example_getTokenViaHTTP() { + // See func authHandler for an example auth handler that produces a token + res, err := http.PostForm(fmt.Sprintf("http://localhost:%v/authenticate", serverPort), url.Values{ + "user": {"test"}, + "pass": {"known"}, + }) + if err != nil { + fatal(err) + } + + if res.StatusCode != 200 { + fmt.Println("Unexpected status code", res.StatusCode) + } + + // Read the token out of the response body + buf := new(bytes.Buffer) + io.Copy(buf, res.Body) + res.Body.Close() + tokenString := strings.TrimSpace(buf.String()) + + // Parse the token + token, err := jwt.ParseWithClaims(tokenString, &CustomClaimsExample{}, func(token *jwt.Token) (interface{}, error) { + // since we only use the one private key to sign the tokens, + // we also only use its public counter part to verify + return verifyKey, nil + }) + fatal(err) + + claims := token.Claims.(*CustomClaimsExample) + fmt.Println(claims.CustomerInfo.Name) + + //Output: test +} + +func Example_useTokenViaHTTP() { + + // Make a sample token + // In a real world situation, this token will have been acquired from + // some other API call (see Example_getTokenViaHTTP) + token, err := createToken("foo") + fatal(err) + + // Make request. See func restrictedHandler for example request processor + req, err := http.NewRequest("GET", fmt.Sprintf("http://localhost:%v/restricted", serverPort), nil) + fatal(err) + req.Header.Set("Authorization", fmt.Sprintf("Bearer %v", token)) + res, err := http.DefaultClient.Do(req) + fatal(err) + + // Read the response body + buf := new(bytes.Buffer) + io.Copy(buf, res.Body) + res.Body.Close() + fmt.Println(buf.String()) + + // Output: Welcome, foo +} + +func createToken(user string) (string, error) { + // create a signer for rsa 256 + t := jwt.New(jwt.GetSigningMethod("RS256")) + + // set our claims + t.Claims = &CustomClaimsExample{ + &jwt.StandardClaims{ + // set the expire time + // see http://tools.ietf.org/html/draft-ietf-oauth-json-web-token-20#section-4.1.4 + ExpiresAt: time.Now().Add(time.Minute * 1).Unix(), + }, + "level1", + CustomerInfo{user, "human"}, + } + + // Creat token string + return t.SignedString(signKey) +} + +// reads the form values, checks them and creates the token +func authHandler(w http.ResponseWriter, r *http.Request) { + // make sure its post + if r.Method != "POST" { + w.WriteHeader(http.StatusBadRequest) + fmt.Fprintln(w, "No POST", r.Method) + return + } + + user := r.FormValue("user") + pass := r.FormValue("pass") + + log.Printf("Authenticate: user[%s] pass[%s]\n", user, pass) + + // check values + if user != "test" || pass != "known" { + w.WriteHeader(http.StatusForbidden) + fmt.Fprintln(w, "Wrong info") + return + } + + tokenString, err := createToken(user) + if err != nil { + w.WriteHeader(http.StatusInternalServerError) + fmt.Fprintln(w, "Sorry, error while Signing Token!") + log.Printf("Token Signing error: %v\n", err) + return + } + + w.Header().Set("Content-Type", "application/jwt") + w.WriteHeader(http.StatusOK) + fmt.Fprintln(w, tokenString) +} + +// only accessible with a valid token +func restrictedHandler(w http.ResponseWriter, r *http.Request) { + // Get token from request + token, err := request.ParseFromRequestWithClaims(r, request.OAuth2Extractor, &CustomClaimsExample{}, func(token *jwt.Token) (interface{}, error) { + // since we only use the one private key to sign the tokens, + // we also only use its public counter part to verify + return verifyKey, nil + }) + + // If the token is missing or invalid, return error + if err != nil { + w.WriteHeader(http.StatusUnauthorized) + fmt.Fprintln(w, "Invalid token:", err) + return + } + + // Token is valid + fmt.Fprintln(w, "Welcome,", token.Claims.(*CustomClaimsExample).Name) + return +} diff --git a/vendor/github.com/dgrijalva/jwt-go/map_claims.go b/vendor/github.com/dgrijalva/jwt-go/map_claims.go new file mode 100644 index 000000000..291213c46 --- /dev/null +++ b/vendor/github.com/dgrijalva/jwt-go/map_claims.go @@ -0,0 +1,94 @@ +package jwt + +import ( + "encoding/json" + "errors" + // "fmt" +) + +// Claims type that uses the map[string]interface{} for JSON decoding +// This is the default claims type if you don't supply one +type MapClaims map[string]interface{} + +// Compares the aud claim against cmp. +// If required is false, this method will return true if the value matches or is unset +func (m MapClaims) VerifyAudience(cmp string, req bool) bool { + aud, _ := m["aud"].(string) + return verifyAud(aud, cmp, req) +} + +// Compares the exp claim against cmp. +// If required is false, this method will return true if the value matches or is unset +func (m MapClaims) VerifyExpiresAt(cmp int64, req bool) bool { + switch exp := m["exp"].(type) { + case float64: + return verifyExp(int64(exp), cmp, req) + case json.Number: + v, _ := exp.Int64() + return verifyExp(v, cmp, req) + } + return req == false +} + +// Compares the iat claim against cmp. +// If required is false, this method will return true if the value matches or is unset +func (m MapClaims) VerifyIssuedAt(cmp int64, req bool) bool { + switch iat := m["iat"].(type) { + case float64: + return verifyIat(int64(iat), cmp, req) + case json.Number: + v, _ := iat.Int64() + return verifyIat(v, cmp, req) + } + return req == false +} + +// Compares the iss claim against cmp. +// If required is false, this method will return true if the value matches or is unset +func (m MapClaims) VerifyIssuer(cmp string, req bool) bool { + iss, _ := m["iss"].(string) + return verifyIss(iss, cmp, req) +} + +// Compares the nbf claim against cmp. +// If required is false, this method will return true if the value matches or is unset +func (m MapClaims) VerifyNotBefore(cmp int64, req bool) bool { + switch nbf := m["nbf"].(type) { + case float64: + return verifyNbf(int64(nbf), cmp, req) + case json.Number: + v, _ := nbf.Int64() + return verifyNbf(v, cmp, req) + } + return req == false +} + +// Validates time based claims "exp, iat, nbf". +// There is no accounting for clock skew. +// As well, if any of the above claims are not in the token, it will still +// be considered a valid claim. +func (m MapClaims) Valid() error { + vErr := new(ValidationError) + now := TimeFunc().Unix() + + if m.VerifyExpiresAt(now, false) == false { + vErr.Inner = errors.New("Token is expired") + vErr.Errors |= ValidationErrorExpired + } + + if m.VerifyIssuedAt(now, false) == false { + vErr.Inner = errors.New("Token used before issued") + vErr.Errors |= ValidationErrorIssuedAt + } + + if m.VerifyNotBefore(now, false) == false { + vErr.Inner = errors.New("Token is not valid yet") + vErr.Errors |= ValidationErrorNotValidYet + } + + if vErr.valid() { + return nil + } + + return vErr +} diff --git a/vendor/github.com/dgrijalva/jwt-go/none.go b/vendor/github.com/dgrijalva/jwt-go/none.go new file mode 100644 index 000000000..f04d189d0 --- /dev/null +++ b/vendor/github.com/dgrijalva/jwt-go/none.go @@ -0,0 +1,52 @@ +package jwt + +// Implements the none signing method. This is required by the spec +// but you probably should never use it. +var SigningMethodNone *signingMethodNone + +const UnsafeAllowNoneSignatureType unsafeNoneMagicConstant = "none signing method allowed" + +var NoneSignatureTypeDisallowedError error + +type signingMethodNone struct{} +type unsafeNoneMagicConstant string + +func init() { + SigningMethodNone = &signingMethodNone{} + NoneSignatureTypeDisallowedError = NewValidationError("'none' signature type is not allowed", ValidationErrorSignatureInvalid) + + RegisterSigningMethod(SigningMethodNone.Alg(), func() SigningMethod { + return SigningMethodNone + }) +} + +func (m *signingMethodNone) Alg() string { + return "none" +} + +// Only allow 'none' alg type if UnsafeAllowNoneSignatureType is specified as the key +func (m *signingMethodNone) Verify(signingString, signature string, key interface{}) (err error) { + // Key must be UnsafeAllowNoneSignatureType to prevent accidentally + // accepting 'none' signing method + if _, ok := key.(unsafeNoneMagicConstant); !ok { + return NoneSignatureTypeDisallowedError + } + // If signing method is none, signature must be an empty string + if signature != "" { + return NewValidationError( + "'none' signing method with non-empty signature", + ValidationErrorSignatureInvalid, + ) + } + + // Accept 'none' signing method. + return nil +} + +// Only allow 'none' signing if UnsafeAllowNoneSignatureType is specified as the key +func (m *signingMethodNone) Sign(signingString string, key interface{}) (string, error) { + if _, ok := key.(unsafeNoneMagicConstant); ok { + return "", nil + } + return "", NoneSignatureTypeDisallowedError +} diff --git a/vendor/github.com/dgrijalva/jwt-go/none_test.go b/vendor/github.com/dgrijalva/jwt-go/none_test.go new file mode 100644 index 000000000..29a69efef --- /dev/null +++ b/vendor/github.com/dgrijalva/jwt-go/none_test.go @@ -0,0 +1,72 @@ +package jwt_test + +import ( + "github.com/dgrijalva/jwt-go" + "strings" + "testing" +) + +var noneTestData = []struct { + name string + tokenString string + alg string + key interface{} + claims map[string]interface{} + valid bool +}{ + { + "Basic", + "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJmb28iOiJiYXIifQ.", + "none", + jwt.UnsafeAllowNoneSignatureType, + map[string]interface{}{"foo": "bar"}, + true, + }, + { + "Basic - no key", + "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJmb28iOiJiYXIifQ.", + "none", + nil, + map[string]interface{}{"foo": "bar"}, + false, + }, + { + "Signed", + "eyJhbGciOiJSUzM4NCIsInR5cCI6IkpXVCJ9.eyJmb28iOiJiYXIifQ.W-jEzRfBigtCWsinvVVuldiuilzVdU5ty0MvpLaSaqK9PlAWWlDQ1VIQ_qSKzwL5IXaZkvZFJXT3yL3n7OUVu7zCNJzdwznbC8Z-b0z2lYvcklJYi2VOFRcGbJtXUqgjk2oGsiqUMUMOLP70TTefkpsgqDxbRh9CDUfpOJgW-dU7cmgaoswe3wjUAUi6B6G2YEaiuXC0XScQYSYVKIzgKXJV8Zw-7AN_DBUI4GkTpsvQ9fVVjZM9csQiEXhYekyrKu1nu_POpQonGd8yqkIyXPECNmmqH5jH4sFiF67XhD7_JpkvLziBpI-uh86evBUadmHhb9Otqw3uV3NTaXLzJw", + "none", + jwt.UnsafeAllowNoneSignatureType, + map[string]interface{}{"foo": "bar"}, + false, + }, +} + +func TestNoneVerify(t *testing.T) { + for _, data := range noneTestData { + parts := strings.Split(data.tokenString, ".") + + method := jwt.GetSigningMethod(data.alg) + err := method.Verify(strings.Join(parts[0:2], "."), parts[2], data.key) + if data.valid && err != nil { + t.Errorf("[%v] Error while verifying key: %v", data.name, err) + } + if !data.valid && err == nil { + t.Errorf("[%v] Invalid key passed validation", data.name) + } + } +} + +func TestNoneSign(t *testing.T) { + for _, data := range noneTestData { + if data.valid { + parts := strings.Split(data.tokenString, ".") + method := jwt.GetSigningMethod(data.alg) + sig, err := method.Sign(strings.Join(parts[0:2], "."), data.key) + if err != nil { + t.Errorf("[%v] Error signing token: %v", data.name, err) + } + if sig != parts[2] { + t.Errorf("[%v] Incorrect signature.\nwas:\n%v\nexpecting:\n%v", data.name, sig, parts[2]) + } + } + } +} diff --git a/vendor/github.com/dgrijalva/jwt-go/parser.go b/vendor/github.com/dgrijalva/jwt-go/parser.go new file mode 100644 index 000000000..7020c52a1 --- /dev/null +++ b/vendor/github.com/dgrijalva/jwt-go/parser.go @@ -0,0 +1,128 @@ +package jwt + +import ( + "bytes" + "encoding/json" + "fmt" + "strings" +) + +type Parser struct { + ValidMethods []string // If populated, only these methods will be considered valid + UseJSONNumber bool // Use JSON Number format in JSON decoder +} + +// Parse, validate, and return a token. +// keyFunc will receive the parsed token and should return the key for validating. +// If everything is kosher, err will be nil +func (p *Parser) Parse(tokenString string, keyFunc Keyfunc) (*Token, error) { + return p.ParseWithClaims(tokenString, MapClaims{}, keyFunc) +} + +func (p *Parser) ParseWithClaims(tokenString string, claims Claims, keyFunc Keyfunc) (*Token, error) { + parts := strings.Split(tokenString, ".") + if len(parts) != 3 { + return nil, NewValidationError("token contains an invalid number of segments", ValidationErrorMalformed) + } + + var err error + token := &Token{Raw: tokenString} + + // parse Header + var headerBytes []byte + if headerBytes, err = DecodeSegment(parts[0]); err != nil { + if strings.HasPrefix(strings.ToLower(tokenString), "bearer ") { + return token, NewValidationError("tokenstring should not contain 'bearer '", ValidationErrorMalformed) + } + return token, &ValidationError{Inner: err, Errors: ValidationErrorMalformed} + } + if err = json.Unmarshal(headerBytes, &token.Header); err != nil { + return token, &ValidationError{Inner: err, Errors: ValidationErrorMalformed} + } + + // parse Claims + var claimBytes []byte + token.Claims = claims + + if claimBytes, err = DecodeSegment(parts[1]); err != nil { + return token, &ValidationError{Inner: err, Errors: ValidationErrorMalformed} + } + dec := json.NewDecoder(bytes.NewBuffer(claimBytes)) + if p.UseJSONNumber { + dec.UseNumber() + } + // JSON Decode. Special case for map type to avoid weird pointer behavior + if c, ok := token.Claims.(MapClaims); ok { + err = dec.Decode(&c) + } else { + err = dec.Decode(&claims) + } + // Handle decode error + if err != nil { + return token, &ValidationError{Inner: err, Errors: ValidationErrorMalformed} + } + + // Lookup signature method + if method, ok := token.Header["alg"].(string); ok { + if token.Method = GetSigningMethod(method); token.Method == nil { + return token, NewValidationError("signing method (alg) is unavailable.", ValidationErrorUnverifiable) + } + } else { + return token, NewValidationError("signing method (alg) is unspecified.", ValidationErrorUnverifiable) + } + + // Verify signing method is in the required set + if p.ValidMethods != nil { + var signingMethodValid = false + var alg = token.Method.Alg() + for _, m := range p.ValidMethods { + if m == alg { + signingMethodValid = true + break + } + } + if !signingMethodValid { + // signing method is not in the listed set + return token, NewValidationError(fmt.Sprintf("signing method %v is invalid", alg), ValidationErrorSignatureInvalid) + } + } + + // Lookup key + var key interface{} + if keyFunc == nil { + // keyFunc was not provided. short circuiting validation + return token, NewValidationError("no Keyfunc was provided.", ValidationErrorUnverifiable) + } + if key, err = keyFunc(token); err != nil { + // keyFunc returned an error + return token, &ValidationError{Inner: err, Errors: ValidationErrorUnverifiable} + } + + vErr := &ValidationError{} + + // Validate Claims + if err := token.Claims.Valid(); err != nil { + + // If the Claims Valid returned an error, check if it is a validation error, + // If it was another error type, create a ValidationError with a generic ClaimsInvalid flag set + if e, ok := err.(*ValidationError); !ok { + vErr = &ValidationError{Inner: err, Errors: ValidationErrorClaimsInvalid} + } else { + vErr = e + } + } + + // Perform validation + token.Signature = parts[2] + if err = token.Method.Verify(strings.Join(parts[0:2], "."), token.Signature, key); err != nil { + vErr.Inner = err + vErr.Errors |= ValidationErrorSignatureInvalid + } + + if vErr.valid() { + token.Valid = true + return token, nil + } + + return token, vErr +} diff --git a/vendor/github.com/dgrijalva/jwt-go/parser_test.go b/vendor/github.com/dgrijalva/jwt-go/parser_test.go new file mode 100644 index 000000000..0c86801b9 --- /dev/null +++ b/vendor/github.com/dgrijalva/jwt-go/parser_test.go @@ -0,0 +1,252 @@ +package jwt_test + +import ( + "crypto/rsa" + "encoding/json" + "fmt" + "reflect" + "testing" + "time" + + "github.com/dgrijalva/jwt-go" + "github.com/dgrijalva/jwt-go/test" +) + +var keyFuncError error = fmt.Errorf("error loading key") + +var ( + jwtTestDefaultKey *rsa.PublicKey + defaultKeyFunc jwt.Keyfunc = func(t *jwt.Token) (interface{}, error) { return jwtTestDefaultKey, nil } + emptyKeyFunc jwt.Keyfunc = func(t *jwt.Token) (interface{}, error) { return nil, nil } + errorKeyFunc jwt.Keyfunc = func(t *jwt.Token) (interface{}, error) { return nil, keyFuncError } + nilKeyFunc jwt.Keyfunc = nil +) + +func init() { + jwtTestDefaultKey = test.LoadRSAPublicKeyFromDisk("test/sample_key.pub") +} + +var jwtTestData = []struct { + name string + tokenString string + keyfunc jwt.Keyfunc + claims jwt.Claims + valid bool + errors uint32 + parser *jwt.Parser +}{ + { + "basic", + "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJmb28iOiJiYXIifQ.FhkiHkoESI_cG3NPigFrxEk9Z60_oXrOT2vGm9Pn6RDgYNovYORQmmA0zs1AoAOf09ly2Nx2YAg6ABqAYga1AcMFkJljwxTT5fYphTuqpWdy4BELeSYJx5Ty2gmr8e7RonuUztrdD5WfPqLKMm1Ozp_T6zALpRmwTIW0QPnaBXaQD90FplAg46Iy1UlDKr-Eupy0i5SLch5Q-p2ZpaL_5fnTIUDlxC3pWhJTyx_71qDI-mAA_5lE_VdroOeflG56sSmDxopPEG3bFlSu1eowyBfxtu0_CuVd-M42RU75Zc4Gsj6uV77MBtbMrf4_7M_NUTSgoIF3fRqxrj0NzihIBg", + defaultKeyFunc, + jwt.MapClaims{"foo": "bar"}, + true, + 0, + nil, + }, + { + "basic expired", + "", // autogen + defaultKeyFunc, + jwt.MapClaims{"foo": "bar", "exp": float64(time.Now().Unix() - 100)}, + false, + jwt.ValidationErrorExpired, + nil, + }, + { + "basic nbf", + "", // autogen + defaultKeyFunc, + jwt.MapClaims{"foo": "bar", "nbf": float64(time.Now().Unix() + 100)}, + false, + jwt.ValidationErrorNotValidYet, + nil, + }, + { + "expired and nbf", + "", // autogen + defaultKeyFunc, + jwt.MapClaims{"foo": "bar", "nbf": float64(time.Now().Unix() + 100), "exp": float64(time.Now().Unix() - 100)}, + false, + jwt.ValidationErrorNotValidYet | jwt.ValidationErrorExpired, + nil, + }, + { + "basic invalid", + "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJmb28iOiJiYXIifQ.EhkiHkoESI_cG3NPigFrxEk9Z60_oXrOT2vGm9Pn6RDgYNovYORQmmA0zs1AoAOf09ly2Nx2YAg6ABqAYga1AcMFkJljwxTT5fYphTuqpWdy4BELeSYJx5Ty2gmr8e7RonuUztrdD5WfPqLKMm1Ozp_T6zALpRmwTIW0QPnaBXaQD90FplAg46Iy1UlDKr-Eupy0i5SLch5Q-p2ZpaL_5fnTIUDlxC3pWhJTyx_71qDI-mAA_5lE_VdroOeflG56sSmDxopPEG3bFlSu1eowyBfxtu0_CuVd-M42RU75Zc4Gsj6uV77MBtbMrf4_7M_NUTSgoIF3fRqxrj0NzihIBg", + defaultKeyFunc, + jwt.MapClaims{"foo": "bar"}, + false, + jwt.ValidationErrorSignatureInvalid, + nil, + }, + { + "basic nokeyfunc", + "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJmb28iOiJiYXIifQ.FhkiHkoESI_cG3NPigFrxEk9Z60_oXrOT2vGm9Pn6RDgYNovYORQmmA0zs1AoAOf09ly2Nx2YAg6ABqAYga1AcMFkJljwxTT5fYphTuqpWdy4BELeSYJx5Ty2gmr8e7RonuUztrdD5WfPqLKMm1Ozp_T6zALpRmwTIW0QPnaBXaQD90FplAg46Iy1UlDKr-Eupy0i5SLch5Q-p2ZpaL_5fnTIUDlxC3pWhJTyx_71qDI-mAA_5lE_VdroOeflG56sSmDxopPEG3bFlSu1eowyBfxtu0_CuVd-M42RU75Zc4Gsj6uV77MBtbMrf4_7M_NUTSgoIF3fRqxrj0NzihIBg", + nilKeyFunc, + jwt.MapClaims{"foo": "bar"}, + false, + jwt.ValidationErrorUnverifiable, + nil, + }, + { + "basic nokey", + "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJmb28iOiJiYXIifQ.FhkiHkoESI_cG3NPigFrxEk9Z60_oXrOT2vGm9Pn6RDgYNovYORQmmA0zs1AoAOf09ly2Nx2YAg6ABqAYga1AcMFkJljwxTT5fYphTuqpWdy4BELeSYJx5Ty2gmr8e7RonuUztrdD5WfPqLKMm1Ozp_T6zALpRmwTIW0QPnaBXaQD90FplAg46Iy1UlDKr-Eupy0i5SLch5Q-p2ZpaL_5fnTIUDlxC3pWhJTyx_71qDI-mAA_5lE_VdroOeflG56sSmDxopPEG3bFlSu1eowyBfxtu0_CuVd-M42RU75Zc4Gsj6uV77MBtbMrf4_7M_NUTSgoIF3fRqxrj0NzihIBg", + emptyKeyFunc, + jwt.MapClaims{"foo": "bar"}, + false, + jwt.ValidationErrorSignatureInvalid, + nil, + }, + { + "basic errorkey", + "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJmb28iOiJiYXIifQ.FhkiHkoESI_cG3NPigFrxEk9Z60_oXrOT2vGm9Pn6RDgYNovYORQmmA0zs1AoAOf09ly2Nx2YAg6ABqAYga1AcMFkJljwxTT5fYphTuqpWdy4BELeSYJx5Ty2gmr8e7RonuUztrdD5WfPqLKMm1Ozp_T6zALpRmwTIW0QPnaBXaQD90FplAg46Iy1UlDKr-Eupy0i5SLch5Q-p2ZpaL_5fnTIUDlxC3pWhJTyx_71qDI-mAA_5lE_VdroOeflG56sSmDxopPEG3bFlSu1eowyBfxtu0_CuVd-M42RU75Zc4Gsj6uV77MBtbMrf4_7M_NUTSgoIF3fRqxrj0NzihIBg", + errorKeyFunc, + jwt.MapClaims{"foo": "bar"}, + false, + jwt.ValidationErrorUnverifiable, + nil, + }, + { + "invalid signing method", + "", + defaultKeyFunc, + jwt.MapClaims{"foo": "bar"}, + false, + jwt.ValidationErrorSignatureInvalid, + &jwt.Parser{ValidMethods: []string{"HS256"}}, + }, + { + "valid signing method", + "", + defaultKeyFunc, + jwt.MapClaims{"foo": "bar"}, + true, + 0, + &jwt.Parser{ValidMethods: []string{"RS256", "HS256"}}, + }, + { + "JSON Number", + "", + defaultKeyFunc, + jwt.MapClaims{"foo": json.Number("123.4")}, + true, + 0, + &jwt.Parser{UseJSONNumber: true}, + }, + { + "Standard Claims", + "", + defaultKeyFunc, + &jwt.StandardClaims{ + ExpiresAt: time.Now().Add(time.Second * 10).Unix(), + }, + true, + 0, + &jwt.Parser{UseJSONNumber: true}, + }, + { + "JSON Number - basic expired", + "", // autogen + defaultKeyFunc, + jwt.MapClaims{"foo": "bar", "exp": json.Number(fmt.Sprintf("%v", time.Now().Unix()-100))}, + false, + jwt.ValidationErrorExpired, + &jwt.Parser{UseJSONNumber: true}, + }, + { + "JSON Number - basic nbf", + "", // autogen + defaultKeyFunc, + jwt.MapClaims{"foo": "bar", "nbf": json.Number(fmt.Sprintf("%v", time.Now().Unix()+100))}, + false, + jwt.ValidationErrorNotValidYet, + &jwt.Parser{UseJSONNumber: true}, + }, + { + "JSON Number - expired and nbf", + "", // autogen + defaultKeyFunc, + jwt.MapClaims{"foo": "bar", "nbf": json.Number(fmt.Sprintf("%v", time.Now().Unix()+100)), "exp": json.Number(fmt.Sprintf("%v", time.Now().Unix()-100))}, + false, + jwt.ValidationErrorNotValidYet | jwt.ValidationErrorExpired, + &jwt.Parser{UseJSONNumber: true}, + }, +} + +func TestParser_Parse(t *testing.T) { + privateKey := test.LoadRSAPrivateKeyFromDisk("test/sample_key") + + // Iterate over test data set and run tests + for _, data := range jwtTestData { + // If the token string is blank, use helper function to generate string + if data.tokenString == "" { + data.tokenString = test.MakeSampleToken(data.claims, privateKey) + } + + // Parse the token + var token *jwt.Token + var err error + var parser = data.parser + if parser == nil { + parser = new(jwt.Parser) + } + // Figure out correct claims type + switch data.claims.(type) { + case jwt.MapClaims: + token, err = parser.ParseWithClaims(data.tokenString, jwt.MapClaims{}, data.keyfunc) + case *jwt.StandardClaims: + token, err = parser.ParseWithClaims(data.tokenString, &jwt.StandardClaims{}, data.keyfunc) + } + + // Verify result matches expectation + if !reflect.DeepEqual(data.claims, token.Claims) { + t.Errorf("[%v] Claims mismatch. Expecting: %v Got: %v", data.name, data.claims, token.Claims) + } + + if data.valid && err != nil { + t.Errorf("[%v] Error while verifying token: %T:%v", data.name, err, err) + } + + if !data.valid && err == nil { + t.Errorf("[%v] Invalid token passed validation", data.name) + } + + if (err == nil && !token.Valid) || (err != nil && token.Valid) { + t.Errorf("[%v] Inconsistent behavior between returned error and token.Valid") + } + + if data.errors != 0 { + if err == nil { + t.Errorf("[%v] Expecting error. Didn't get one.", data.name) + } else { + + ve := err.(*jwt.ValidationError) + // compare the bitfield part of the error + if e := ve.Errors; e != data.errors { + t.Errorf("[%v] Errors don't match expectation. %v != %v", data.name, e, data.errors) + } + + if err.Error() == keyFuncError.Error() && ve.Inner != keyFuncError { + t.Errorf("[%v] Inner error does not match expectation. %v != %v", data.name, ve.Inner, keyFuncError) + } + } + } + if data.valid && token.Signature == "" { + t.Errorf("[%v] Signature is left unpopulated after parsing", data.name) + } + } +} + +// Helper method for benchmarking various methods +func benchmarkSigning(b *testing.B, method jwt.SigningMethod, key interface{}) { + t := jwt.New(method) + b.RunParallel(func(pb *testing.PB) { + for pb.Next() { + if _, err := t.SignedString(key); err != nil { + b.Fatal(err) + } + } + }) + +} diff --git a/vendor/github.com/dgrijalva/jwt-go/request/doc.go b/vendor/github.com/dgrijalva/jwt-go/request/doc.go new file mode 100644 index 000000000..c01069c98 --- /dev/null +++ b/vendor/github.com/dgrijalva/jwt-go/request/doc.go @@ -0,0 +1,7 @@ +// Utility package for extracting JWT tokens from +// HTTP requests. +// +// The main function is ParseFromRequest and it's WithClaims variant. +// See examples for how to use the various Extractor implementations +// or roll your own. +package request diff --git a/vendor/github.com/dgrijalva/jwt-go/request/extractor.go b/vendor/github.com/dgrijalva/jwt-go/request/extractor.go new file mode 100644 index 000000000..14414fe2f --- /dev/null +++ b/vendor/github.com/dgrijalva/jwt-go/request/extractor.go @@ -0,0 +1,81 @@ +package request + +import ( + "errors" + "net/http" +) + +// Errors +var ( + ErrNoTokenInRequest = errors.New("no token present in request") +) + +// Interface for extracting a token from an HTTP request. +// The ExtractToken method should return a token string or an error. +// If no token is present, you must return ErrNoTokenInRequest. +type Extractor interface { + ExtractToken(*http.Request) (string, error) +} + +// Extractor for finding a token in a header. Looks at each specified +// header in order until there's a match +type HeaderExtractor []string + +func (e HeaderExtractor) ExtractToken(req *http.Request) (string, error) { + // loop over header names and return the first one that contains data + for _, header := range e { + if ah := req.Header.Get(header); ah != "" { + return ah, nil + } + } + return "", ErrNoTokenInRequest +} + +// Extract token from request arguments. This includes a POSTed form or +// GET URL arguments. Argument names are tried in order until there's a match. +// This extractor calls `ParseMultipartForm` on the request +type ArgumentExtractor []string + +func (e ArgumentExtractor) ExtractToken(req *http.Request) (string, error) { + // Make sure form is parsed + req.ParseMultipartForm(10e6) + + // loop over arg names and return the first one that contains data + for _, arg := range e { + if ah := req.Form.Get(arg); ah != "" { + return ah, nil + } + } + + return "", ErrNoTokenInRequest +} + +// Tries Extractors in order until one returns a token string or an error occurs +type MultiExtractor []Extractor + +func (e MultiExtractor) ExtractToken(req *http.Request) (string, error) { + // loop over header names and return the first one that contains data + for _, extractor := range e { + if tok, err := extractor.ExtractToken(req); tok != "" { + return tok, nil + } else if err != ErrNoTokenInRequest { + return "", err + } + } + return "", ErrNoTokenInRequest +} + +// Wrap an Extractor in this to post-process the value before it's handed off. +// See AuthorizationHeaderExtractor for an example +type PostExtractionFilter struct { + Extractor + Filter func(string) (string, error) +} + +func (e *PostExtractionFilter) ExtractToken(req *http.Request) (string, error) { + if tok, err := e.Extractor.ExtractToken(req); tok != "" { + return e.Filter(tok) + } else { + return "", err + } +} diff --git a/vendor/github.com/dgrijalva/jwt-go/request/extractor_example_test.go b/vendor/github.com/dgrijalva/jwt-go/request/extractor_example_test.go new file mode 100644 index 000000000..a994ffe58 --- /dev/null +++ b/vendor/github.com/dgrijalva/jwt-go/request/extractor_example_test.go @@ -0,0 +1,32 @@ +package request + +import ( + "fmt" + "net/url" +) + +const ( + exampleTokenA = "A" +) + +func ExampleHeaderExtractor() { + req := makeExampleRequest("GET", "/", map[string]string{"Token": exampleTokenA}, nil) + tokenString, err := HeaderExtractor{"Token"}.ExtractToken(req) + if err == nil { + fmt.Println(tokenString) + } else { + fmt.Println(err) + } + //Output: A +} + +func ExampleArgumentExtractor() { + req := makeExampleRequest("GET", "/", nil, url.Values{"token": {extractorTestTokenA}}) + tokenString, err := ArgumentExtractor{"token"}.ExtractToken(req) + if err == nil { + fmt.Println(tokenString) + } else { + fmt.Println(err) + } + //Output: A +} diff --git a/vendor/github.com/dgrijalva/jwt-go/request/extractor_test.go b/vendor/github.com/dgrijalva/jwt-go/request/extractor_test.go new file mode 100644 index 000000000..e3bbb0a3e --- /dev/null +++ b/vendor/github.com/dgrijalva/jwt-go/request/extractor_test.go @@ -0,0 +1,91 @@ +package request + +import ( + "fmt" + "net/http" + "net/url" + "testing" +) + +var extractorTestTokenA = "A" +var extractorTestTokenB = "B" + +var extractorTestData = []struct { + name string + extractor Extractor + headers map[string]string + query url.Values + token string + err error +}{ + { + name: "simple header", + extractor: HeaderExtractor{"Foo"}, + headers: map[string]string{"Foo": extractorTestTokenA}, + query: nil, + token: extractorTestTokenA, + err: nil, + }, + { + name: "simple argument", + extractor: ArgumentExtractor{"token"}, + headers: map[string]string{}, + query: url.Values{"token": {extractorTestTokenA}}, + token: extractorTestTokenA, + err: nil, + }, + { + name: "multiple extractors", + extractor: MultiExtractor{ + HeaderExtractor{"Foo"}, + ArgumentExtractor{"token"}, + }, + headers: map[string]string{"Foo": extractorTestTokenA}, + query: url.Values{"token": {extractorTestTokenB}}, + token: extractorTestTokenA, + err: nil, + }, + { + name: "simple miss", + extractor: HeaderExtractor{"This-Header-Is-Not-Set"}, + headers: map[string]string{"Foo": extractorTestTokenA}, + query: nil, + token: "", + err: ErrNoTokenInRequest, + }, + { + name: "filter", + extractor: AuthorizationHeaderExtractor, + headers: map[string]string{"Authorization": "Bearer " + extractorTestTokenA}, + query: nil, + token: extractorTestTokenA, + err: nil, + }, +} + +func TestExtractor(t *testing.T) { + // Bearer token request + for _, data := range extractorTestData { + // Make request from test struct + r := makeExampleRequest("GET", "/", data.headers, data.query) + + // Test extractor + token, err := data.extractor.ExtractToken(r) + if token != data.token { + t.Errorf("[%v] Expected token '%v'. Got '%v'", data.name, data.token, token) + continue + } + if err != data.err { + t.Errorf("[%v] Expected error '%v'. Got '%v'", data.name, data.err, err) + continue + } + } +} + +func makeExampleRequest(method, path string, headers map[string]string, urlArgs url.Values) *http.Request { + r, _ := http.NewRequest(method, fmt.Sprintf("%v?%v", path, urlArgs.Encode()), nil) + for k, v := range headers { + r.Header.Set(k, v) + } + return r +} diff --git a/vendor/github.com/dgrijalva/jwt-go/request/oauth2.go b/vendor/github.com/dgrijalva/jwt-go/request/oauth2.go new file mode 100644 index 000000000..5948694a5 --- /dev/null +++ b/vendor/github.com/dgrijalva/jwt-go/request/oauth2.go @@ -0,0 +1,28 @@ +package request + +import ( + "strings" +) + +// Strips 'Bearer ' prefix from bearer token string +func stripBearerPrefixFromTokenString(tok string) (string, error) { + // Should be a bearer token + if len(tok) > 6 && strings.ToUpper(tok[0:7]) == "BEARER " { + return tok[7:], nil + } + return tok, nil +} + +// Extract bearer token from Authorization header +// Uses PostExtractionFilter to strip "Bearer " prefix from header +var AuthorizationHeaderExtractor = &PostExtractionFilter{ + HeaderExtractor{"Authorization"}, + stripBearerPrefixFromTokenString, +} + +// Extractor for OAuth2 access tokens. Looks in 'Authorization' +// header then 'access_token' argument for a token. +var OAuth2Extractor = &MultiExtractor{ + AuthorizationHeaderExtractor, + ArgumentExtractor{"access_token"}, +} diff --git a/vendor/github.com/dgrijalva/jwt-go/request/request.go b/vendor/github.com/dgrijalva/jwt-go/request/request.go new file mode 100644 index 000000000..1807b3965 --- /dev/null +++ b/vendor/github.com/dgrijalva/jwt-go/request/request.go @@ -0,0 +1,24 @@ +package request + +import ( + "github.com/dgrijalva/jwt-go" + "net/http" +) + +// Extract and parse a JWT token from an HTTP request. +// This behaves the same as Parse, but accepts a request and an extractor +// instead of a token string. The Extractor interface allows you to define +// the logic for extracting a token. Several useful implementations are provided. +func ParseFromRequest(req *http.Request, extractor Extractor, keyFunc jwt.Keyfunc) (token *jwt.Token, err error) { + return ParseFromRequestWithClaims(req, extractor, jwt.MapClaims{}, keyFunc) +} + +// ParseFromRequest but with custom Claims type +func ParseFromRequestWithClaims(req *http.Request, extractor Extractor, claims jwt.Claims, keyFunc jwt.Keyfunc) (token *jwt.Token, err error) { + // Extract token from request + if tokStr, err := extractor.ExtractToken(req); err == nil { + return jwt.ParseWithClaims(tokStr, claims, keyFunc) + } else { + return nil, err + } +} diff --git a/vendor/github.com/dgrijalva/jwt-go/request/request_test.go b/vendor/github.com/dgrijalva/jwt-go/request/request_test.go new file mode 100644 index 000000000..b4365cd86 --- /dev/null +++ b/vendor/github.com/dgrijalva/jwt-go/request/request_test.go @@ -0,0 +1,103 @@ +package request + +import ( + "fmt" + "github.com/dgrijalva/jwt-go" + "github.com/dgrijalva/jwt-go/test" + "net/http" + "net/url" + "reflect" + "strings" + "testing" +) + +var requestTestData = []struct { + name string + claims jwt.MapClaims + extractor Extractor + headers map[string]string + query url.Values + valid bool +}{ + { + "authorization bearer token", + jwt.MapClaims{"foo": "bar"}, + AuthorizationHeaderExtractor, + map[string]string{"Authorization": "Bearer %v"}, + url.Values{}, + true, + }, + { + "oauth bearer token - header", + jwt.MapClaims{"foo": "bar"}, + OAuth2Extractor, + map[string]string{"Authorization": "Bearer %v"}, + url.Values{}, + true, + }, + { + "oauth bearer token - url", + jwt.MapClaims{"foo": "bar"}, + OAuth2Extractor, + map[string]string{}, + url.Values{"access_token": {"%v"}}, + true, + }, + { + "url token", + jwt.MapClaims{"foo": "bar"}, + ArgumentExtractor{"token"}, + map[string]string{}, + url.Values{"token": {"%v"}}, + true, + }, +} + +func TestParseRequest(t *testing.T) { + // load keys from disk + privateKey := test.LoadRSAPrivateKeyFromDisk("../test/sample_key") + publicKey := test.LoadRSAPublicKeyFromDisk("../test/sample_key.pub") + keyfunc := func(*jwt.Token) (interface{}, error) { + return publicKey, nil + } + + // Bearer token request + for _, data := range requestTestData { + // Make token from claims + tokenString := test.MakeSampleToken(data.claims, privateKey) + + // Make query string + for k, vv := range data.query { + for i, v := range vv { + if strings.Contains(v, "%v") { + data.query[k][i] = fmt.Sprintf(v, tokenString) + } + } + } + + // Make request from test struct + r, _ := http.NewRequest("GET", fmt.Sprintf("/?%v", data.query.Encode()), nil) + for k, v := range data.headers { + if strings.Contains(v, "%v") { + r.Header.Set(k, fmt.Sprintf(v, tokenString)) + } else { + r.Header.Set(k, tokenString) + } + } + token, err := ParseFromRequestWithClaims(r, data.extractor, jwt.MapClaims{}, keyfunc) + + if token == nil { + t.Errorf("[%v] Token was not found: %v", data.name, err) + continue + } + if !reflect.DeepEqual(data.claims, token.Claims) { + t.Errorf("[%v] Claims mismatch. Expecting: %v Got: %v", data.name, data.claims, token.Claims) + } + if data.valid && err != nil { + t.Errorf("[%v] Error while verifying token: %v", data.name, err) + } + if !data.valid && err == nil { + t.Errorf("[%v] Invalid token passed validation", data.name) + } + } +} diff --git a/vendor/github.com/dgrijalva/jwt-go/rsa.go b/vendor/github.com/dgrijalva/jwt-go/rsa.go new file mode 100644 index 000000000..0ae0b1984 --- /dev/null +++ b/vendor/github.com/dgrijalva/jwt-go/rsa.go @@ -0,0 +1,100 @@ +package jwt + +import ( + "crypto" + "crypto/rand" + "crypto/rsa" +) + +// Implements the RSA family of signing methods signing methods +type SigningMethodRSA struct { + Name string + Hash crypto.Hash +} + +// Specific instances for RS256 and company +var ( + SigningMethodRS256 *SigningMethodRSA + SigningMethodRS384 *SigningMethodRSA + SigningMethodRS512 *SigningMethodRSA +) + +func init() { + // RS256 + SigningMethodRS256 = &SigningMethodRSA{"RS256", crypto.SHA256} + RegisterSigningMethod(SigningMethodRS256.Alg(), func() SigningMethod { + return SigningMethodRS256 + }) + + // RS384 + SigningMethodRS384 = &SigningMethodRSA{"RS384", crypto.SHA384} + RegisterSigningMethod(SigningMethodRS384.Alg(), func() SigningMethod { + return SigningMethodRS384 + }) + + // RS512 + SigningMethodRS512 = &SigningMethodRSA{"RS512", crypto.SHA512} + RegisterSigningMethod(SigningMethodRS512.Alg(), func() SigningMethod { + return SigningMethodRS512 + }) +} + +func (m *SigningMethodRSA) Alg() string { + return m.Name +} + +// Implements the Verify method from SigningMethod +// For this signing method, must be an rsa.PublicKey structure. +func (m *SigningMethodRSA) Verify(signingString, signature string, key interface{}) error { + var err error + + // Decode the signature + var sig []byte + if sig, err = DecodeSegment(signature); err != nil { + return err + } + + var rsaKey *rsa.PublicKey + var ok bool + + if rsaKey, ok = key.(*rsa.PublicKey); !ok { + return ErrInvalidKeyType + } + + // Create hasher + if !m.Hash.Available() { + return ErrHashUnavailable + } + hasher := m.Hash.New() + hasher.Write([]byte(signingString)) + + // Verify the signature + return rsa.VerifyPKCS1v15(rsaKey, m.Hash, hasher.Sum(nil), sig) +} + +// Implements the Sign method from SigningMethod +// For this signing method, must be an rsa.PrivateKey structure. +func (m *SigningMethodRSA) Sign(signingString string, key interface{}) (string, error) { + var rsaKey *rsa.PrivateKey + var ok bool + + // Validate type of key + if rsaKey, ok = key.(*rsa.PrivateKey); !ok { + return "", ErrInvalidKey + } + + // Create the hasher + if !m.Hash.Available() { + return "", ErrHashUnavailable + } + + hasher := m.Hash.New() + hasher.Write([]byte(signingString)) + + // Sign the string and return the encoded bytes + if sigBytes, err := rsa.SignPKCS1v15(rand.Reader, rsaKey, m.Hash, hasher.Sum(nil)); err == nil { + return EncodeSegment(sigBytes), nil + } else { + return "", err + } +} diff --git a/vendor/github.com/dgrijalva/jwt-go/rsa_pss.go b/vendor/github.com/dgrijalva/jwt-go/rsa_pss.go new file mode 100644 index 000000000..10ee9db8a --- /dev/null +++ b/vendor/github.com/dgrijalva/jwt-go/rsa_pss.go @@ -0,0 +1,126 @@ +// +build go1.4 + +package jwt + +import ( + "crypto" + "crypto/rand" + "crypto/rsa" +) + +// Implements the RSAPSS family of signing methods signing methods +type SigningMethodRSAPSS struct { + *SigningMethodRSA + Options *rsa.PSSOptions +} + +// Specific instances for RS/PS and company +var ( + SigningMethodPS256 *SigningMethodRSAPSS + SigningMethodPS384 *SigningMethodRSAPSS + SigningMethodPS512 *SigningMethodRSAPSS +) + +func init() { + // PS256 + SigningMethodPS256 = &SigningMethodRSAPSS{ + &SigningMethodRSA{ + Name: "PS256", + Hash: crypto.SHA256, + }, + &rsa.PSSOptions{ + SaltLength: rsa.PSSSaltLengthAuto, + Hash: crypto.SHA256, + }, + } + RegisterSigningMethod(SigningMethodPS256.Alg(), func() SigningMethod { + return SigningMethodPS256 + }) + + // PS384 + SigningMethodPS384 = &SigningMethodRSAPSS{ + &SigningMethodRSA{ + Name: "PS384", + Hash: crypto.SHA384, + }, + &rsa.PSSOptions{ + SaltLength: rsa.PSSSaltLengthAuto, + Hash: crypto.SHA384, + }, + } + RegisterSigningMethod(SigningMethodPS384.Alg(), func() SigningMethod { + return SigningMethodPS384 + }) + + // PS512 + SigningMethodPS512 = &SigningMethodRSAPSS{ + &SigningMethodRSA{ + Name: "PS512", + Hash: crypto.SHA512, + }, + &rsa.PSSOptions{ + SaltLength: rsa.PSSSaltLengthAuto, + Hash: crypto.SHA512, + }, + } + RegisterSigningMethod(SigningMethodPS512.Alg(), func() SigningMethod { + return SigningMethodPS512 + }) +} + +// Implements the Verify method from SigningMethod +// For this verify method, key must be an rsa.PublicKey struct +func (m *SigningMethodRSAPSS) Verify(signingString, signature string, key interface{}) error { + var err error + + // Decode the signature + var sig []byte + if sig, err = DecodeSegment(signature); err != nil { + return err + } + + var rsaKey *rsa.PublicKey + switch k := key.(type) { + case *rsa.PublicKey: + rsaKey = k + default: + return ErrInvalidKey + } + + // Create hasher + if !m.Hash.Available() { + return ErrHashUnavailable + } + hasher := m.Hash.New() + hasher.Write([]byte(signingString)) + + return rsa.VerifyPSS(rsaKey, m.Hash, hasher.Sum(nil), sig, m.Options) +} + +// Implements the Sign method from SigningMethod +// For this signing method, key must be an rsa.PrivateKey struct +func (m *SigningMethodRSAPSS) Sign(signingString string, key interface{}) (string, error) { + var rsaKey *rsa.PrivateKey + + switch k := key.(type) { + case *rsa.PrivateKey: + rsaKey = k + default: + return "", ErrInvalidKeyType + } + + // Create the hasher + if !m.Hash.Available() { + return "", ErrHashUnavailable + } + + hasher := m.Hash.New() + hasher.Write([]byte(signingString)) + + // Sign the string and return the encoded bytes + if sigBytes, err := rsa.SignPSS(rand.Reader, rsaKey, m.Hash, hasher.Sum(nil), m.Options); err == nil { + return EncodeSegment(sigBytes), nil + } else { + return "", err + } +} diff --git a/vendor/github.com/dgrijalva/jwt-go/rsa_pss_test.go b/vendor/github.com/dgrijalva/jwt-go/rsa_pss_test.go new file mode 100644 index 000000000..9045aaf34 --- /dev/null +++ b/vendor/github.com/dgrijalva/jwt-go/rsa_pss_test.go @@ -0,0 +1,96 @@ +// +build go1.4 + +package jwt_test + +import ( + "crypto/rsa" + "io/ioutil" + "strings" + "testing" + + "github.com/dgrijalva/jwt-go" +) + +var rsaPSSTestData = []struct { + name string + tokenString string + alg string + claims map[string]interface{} + valid bool +}{ + { + "Basic PS256", + "eyJhbGciOiJQUzI1NiIsInR5cCI6IkpXVCJ9.eyJmb28iOiJiYXIifQ.PPG4xyDVY8ffp4CcxofNmsTDXsrVG2npdQuibLhJbv4ClyPTUtR5giNSvuxo03kB6I8VXVr0Y9X7UxhJVEoJOmULAwRWaUsDnIewQa101cVhMa6iR8X37kfFoiZ6NkS-c7henVkkQWu2HtotkEtQvN5hFlk8IevXXPmvZlhQhwzB1sGzGYnoi1zOfuL98d3BIjUjtlwii5w6gYG2AEEzp7HnHCsb3jIwUPdq86Oe6hIFjtBwduIK90ca4UqzARpcfwxHwVLMpatKask00AgGVI0ysdk0BLMjmLutquD03XbThHScC2C2_Pp4cHWgMzvbgLU2RYYZcZRKr46QeNgz9w", + "PS256", + map[string]interface{}{"foo": "bar"}, + true, + }, + { + "Basic PS384", + "eyJhbGciOiJQUzM4NCIsInR5cCI6IkpXVCJ9.eyJmb28iOiJiYXIifQ.w7-qqgj97gK4fJsq_DCqdYQiylJjzWONvD0qWWWhqEOFk2P1eDULPnqHRnjgTXoO4HAw4YIWCsZPet7nR3Xxq4ZhMqvKW8b7KlfRTb9cH8zqFvzMmybQ4jv2hKc3bXYqVow3AoR7hN_CWXI3Dv6Kd2X5xhtxRHI6IL39oTVDUQ74LACe-9t4c3QRPuj6Pq1H4FAT2E2kW_0KOc6EQhCLWEhm2Z2__OZskDC8AiPpP8Kv4k2vB7l0IKQu8Pr4RcNBlqJdq8dA5D3hk5TLxP8V5nG1Ib80MOMMqoS3FQvSLyolFX-R_jZ3-zfq6Ebsqr0yEb0AH2CfsECF7935Pa0FKQ", + "PS384", + map[string]interface{}{"foo": "bar"}, + true, + }, + { + "Basic PS512", + "eyJhbGciOiJQUzUxMiIsInR5cCI6IkpXVCJ9.eyJmb28iOiJiYXIifQ.GX1HWGzFaJevuSLavqqFYaW8_TpvcjQ8KfC5fXiSDzSiT9UD9nB_ikSmDNyDILNdtjZLSvVKfXxZJqCfefxAtiozEDDdJthZ-F0uO4SPFHlGiXszvKeodh7BuTWRI2wL9-ZO4mFa8nq3GMeQAfo9cx11i7nfN8n2YNQ9SHGovG7_T_AvaMZB_jT6jkDHpwGR9mz7x1sycckEo6teLdHRnH_ZdlHlxqknmyTu8Odr5Xh0sJFOL8BepWbbvIIn-P161rRHHiDWFv6nhlHwZnVzjx7HQrWSGb6-s2cdLie9QL_8XaMcUpjLkfOMKkDOfHo6AvpL7Jbwi83Z2ZTHjJWB-A", + "PS512", + map[string]interface{}{"foo": "bar"}, + true, + }, + { + "basic PS256 invalid: foo => bar", + "eyJhbGciOiJQUzI1NiIsInR5cCI6IkpXVCJ9.eyJmb28iOiJiYXIifQ.PPG4xyDVY8ffp4CcxofNmsTDXsrVG2npdQuibLhJbv4ClyPTUtR5giNSvuxo03kB6I8VXVr0Y9X7UxhJVEoJOmULAwRWaUsDnIewQa101cVhMa6iR8X37kfFoiZ6NkS-c7henVkkQWu2HtotkEtQvN5hFlk8IevXXPmvZlhQhwzB1sGzGYnoi1zOfuL98d3BIjUjtlwii5w6gYG2AEEzp7HnHCsb3jIwUPdq86Oe6hIFjtBwduIK90ca4UqzARpcfwxHwVLMpatKask00AgGVI0ysdk0BLMjmLutquD03XbThHScC2C2_Pp4cHWgMzvbgLU2RYYZcZRKr46QeNgz9W", + "PS256", + map[string]interface{}{"foo": "bar"}, + false, + }, +} + +func TestRSAPSSVerify(t *testing.T) { + var err error + + key, _ := ioutil.ReadFile("test/sample_key.pub") + var rsaPSSKey *rsa.PublicKey + if rsaPSSKey, err = jwt.ParseRSAPublicKeyFromPEM(key); err != nil { + t.Errorf("Unable to parse RSA public key: %v", err) + } + + for _, data := range rsaPSSTestData { + parts := strings.Split(data.tokenString, ".") + + method := jwt.GetSigningMethod(data.alg) + err := method.Verify(strings.Join(parts[0:2], "."), parts[2], rsaPSSKey) + if data.valid && err != nil { + t.Errorf("[%v] Error while verifying key: %v", data.name, err) + } + if !data.valid && err == nil { + t.Errorf("[%v] Invalid key passed validation", data.name) + } + } +} + +func TestRSAPSSSign(t *testing.T) { + var err error + + key, _ := ioutil.ReadFile("test/sample_key") + var rsaPSSKey *rsa.PrivateKey + if rsaPSSKey, err = jwt.ParseRSAPrivateKeyFromPEM(key); err != nil { + t.Errorf("Unable to parse RSA private key: %v", err) + } + + for _, data := range rsaPSSTestData { + if data.valid { + parts := strings.Split(data.tokenString, ".") + method := jwt.GetSigningMethod(data.alg) + sig, err := method.Sign(strings.Join(parts[0:2], "."), rsaPSSKey) + if err != nil { + t.Errorf("[%v] Error signing token: %v", data.name, err) + } + if sig == parts[2] { + t.Errorf("[%v] Signatures shouldn't match\nnew:\n%v\noriginal:\n%v", data.name, sig, parts[2]) + } + } + } +} diff --git a/vendor/github.com/dgrijalva/jwt-go/rsa_test.go b/vendor/github.com/dgrijalva/jwt-go/rsa_test.go new file mode 100644 index 000000000..2e0f78536 --- /dev/null +++ b/vendor/github.com/dgrijalva/jwt-go/rsa_test.go @@ -0,0 +1,176 @@ +package jwt_test + +import ( + "github.com/dgrijalva/jwt-go" + "io/ioutil" + "strings" + "testing" +) + +var rsaTestData = []struct { + name string + tokenString string + alg string + claims map[string]interface{} + valid bool +}{ + { + "Basic RS256", + "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJmb28iOiJiYXIifQ.FhkiHkoESI_cG3NPigFrxEk9Z60_oXrOT2vGm9Pn6RDgYNovYORQmmA0zs1AoAOf09ly2Nx2YAg6ABqAYga1AcMFkJljwxTT5fYphTuqpWdy4BELeSYJx5Ty2gmr8e7RonuUztrdD5WfPqLKMm1Ozp_T6zALpRmwTIW0QPnaBXaQD90FplAg46Iy1UlDKr-Eupy0i5SLch5Q-p2ZpaL_5fnTIUDlxC3pWhJTyx_71qDI-mAA_5lE_VdroOeflG56sSmDxopPEG3bFlSu1eowyBfxtu0_CuVd-M42RU75Zc4Gsj6uV77MBtbMrf4_7M_NUTSgoIF3fRqxrj0NzihIBg", + "RS256", + map[string]interface{}{"foo": "bar"}, + true, + }, + { + "Basic RS384", + "eyJhbGciOiJSUzM4NCIsInR5cCI6IkpXVCJ9.eyJmb28iOiJiYXIifQ.W-jEzRfBigtCWsinvVVuldiuilzVdU5ty0MvpLaSaqK9PlAWWlDQ1VIQ_qSKzwL5IXaZkvZFJXT3yL3n7OUVu7zCNJzdwznbC8Z-b0z2lYvcklJYi2VOFRcGbJtXUqgjk2oGsiqUMUMOLP70TTefkpsgqDxbRh9CDUfpOJgW-dU7cmgaoswe3wjUAUi6B6G2YEaiuXC0XScQYSYVKIzgKXJV8Zw-7AN_DBUI4GkTpsvQ9fVVjZM9csQiEXhYekyrKu1nu_POpQonGd8yqkIyXPECNmmqH5jH4sFiF67XhD7_JpkvLziBpI-uh86evBUadmHhb9Otqw3uV3NTaXLzJw", + "RS384", + map[string]interface{}{"foo": "bar"}, + true, + }, + { + "Basic RS512", + "eyJhbGciOiJSUzUxMiIsInR5cCI6IkpXVCJ9.eyJmb28iOiJiYXIifQ.zBlLlmRrUxx4SJPUbV37Q1joRcI9EW13grnKduK3wtYKmDXbgDpF1cZ6B-2Jsm5RB8REmMiLpGms-EjXhgnyh2TSHE-9W2gA_jvshegLWtwRVDX40ODSkTb7OVuaWgiy9y7llvcknFBTIg-FnVPVpXMmeV_pvwQyhaz1SSwSPrDyxEmksz1hq7YONXhXPpGaNbMMeDTNP_1oj8DZaqTIL9TwV8_1wb2Odt_Fy58Ke2RVFijsOLdnyEAjt2n9Mxihu9i3PhNBkkxa2GbnXBfq3kzvZ_xxGGopLdHhJjcGWXO-NiwI9_tiu14NRv4L2xC0ItD9Yz68v2ZIZEp_DuzwRQ", + "RS512", + map[string]interface{}{"foo": "bar"}, + true, + }, + { + "basic invalid: foo => bar", + "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJmb28iOiJiYXIifQ.EhkiHkoESI_cG3NPigFrxEk9Z60_oXrOT2vGm9Pn6RDgYNovYORQmmA0zs1AoAOf09ly2Nx2YAg6ABqAYga1AcMFkJljwxTT5fYphTuqpWdy4BELeSYJx5Ty2gmr8e7RonuUztrdD5WfPqLKMm1Ozp_T6zALpRmwTIW0QPnaBXaQD90FplAg46Iy1UlDKr-Eupy0i5SLch5Q-p2ZpaL_5fnTIUDlxC3pWhJTyx_71qDI-mAA_5lE_VdroOeflG56sSmDxopPEG3bFlSu1eowyBfxtu0_CuVd-M42RU75Zc4Gsj6uV77MBtbMrf4_7M_NUTSgoIF3fRqxrj0NzihIBg", + "RS256", + map[string]interface{}{"foo": "bar"}, + false, + }, +} + +func TestRSAVerify(t *testing.T) { + keyData, _ := ioutil.ReadFile("test/sample_key.pub") + key, _ := jwt.ParseRSAPublicKeyFromPEM(keyData) + + for _, data := range rsaTestData { + parts := strings.Split(data.tokenString, ".") + + method := jwt.GetSigningMethod(data.alg) + err := method.Verify(strings.Join(parts[0:2], "."), parts[2], key) + if data.valid && err != nil { + t.Errorf("[%v] Error while verifying key: %v", data.name, err) + } + if !data.valid && err == nil { + t.Errorf("[%v] Invalid key passed validation", data.name) + } + } +} + +func TestRSASign(t *testing.T) { + keyData, _ := ioutil.ReadFile("test/sample_key") + key, _ := jwt.ParseRSAPrivateKeyFromPEM(keyData) + + for _, data := range rsaTestData { + if data.valid { + parts := strings.Split(data.tokenString, ".") + method := jwt.GetSigningMethod(data.alg) + sig, err := method.Sign(strings.Join(parts[0:2], "."), key) + if err != nil { + t.Errorf("[%v] Error signing token: %v", data.name, err) + } + if sig != parts[2] { + t.Errorf("[%v] Incorrect signature.\nwas:\n%v\nexpecting:\n%v", data.name, sig, parts[2]) + } + } + } +} + +func TestRSAVerifyWithPreParsedPrivateKey(t *testing.T) { + key, _ := ioutil.ReadFile("test/sample_key.pub") + parsedKey, err := jwt.ParseRSAPublicKeyFromPEM(key) + if err != nil { + t.Fatal(err) + } + testData := rsaTestData[0] + parts := strings.Split(testData.tokenString, ".") + err = jwt.SigningMethodRS256.Verify(strings.Join(parts[0:2], "."), parts[2], parsedKey) + if err != nil { + t.Errorf("[%v] Error while verifying key: %v", testData.name, err) + } +} + +func TestRSAWithPreParsedPrivateKey(t *testing.T) { + key, _ := ioutil.ReadFile("test/sample_key") + parsedKey, err := jwt.ParseRSAPrivateKeyFromPEM(key) + if err != nil { + t.Fatal(err) + } + testData := rsaTestData[0] + parts := strings.Split(testData.tokenString, ".") + sig, err := jwt.SigningMethodRS256.Sign(strings.Join(parts[0:2], "."), parsedKey) + if err != nil { + t.Errorf("[%v] Error signing token: %v", testData.name, err) + } + if sig != parts[2] { + t.Errorf("[%v] Incorrect signature.\nwas:\n%v\nexpecting:\n%v", testData.name, sig, parts[2]) + } +} + +func TestRSAKeyParsing(t *testing.T) { + key, _ := ioutil.ReadFile("test/sample_key") + pubKey, _ := ioutil.ReadFile("test/sample_key.pub") + badKey := []byte("All your base are belong to key") + + // Test parsePrivateKey + if _, e := jwt.ParseRSAPrivateKeyFromPEM(key); e != nil { + t.Errorf("Failed to parse valid private key: %v", e) + } + + if k, e := jwt.ParseRSAPrivateKeyFromPEM(pubKey); e == nil { + t.Errorf("Parsed public key as valid private key: %v", k) + } + + if k, e := jwt.ParseRSAPrivateKeyFromPEM(badKey); e == nil { + t.Errorf("Parsed invalid key as valid private key: %v", k) + } + + // Test parsePublicKey + if _, e := jwt.ParseRSAPublicKeyFromPEM(pubKey); e != nil { + t.Errorf("Failed to parse valid public key: %v", e) + } + + if k, e := jwt.ParseRSAPublicKeyFromPEM(key); e == nil { + t.Errorf("Parsed private key as valid public key: %v", k) + } + + if k, e := jwt.ParseRSAPublicKeyFromPEM(badKey); e == nil { + t.Errorf("Parsed invalid key as valid private key: %v", k) + } + +} + +func BenchmarkRS256Signing(b *testing.B) { + key, _ := ioutil.ReadFile("test/sample_key") + parsedKey, err := jwt.ParseRSAPrivateKeyFromPEM(key) + if err != nil { + b.Fatal(err) + } + + benchmarkSigning(b, jwt.SigningMethodRS256, parsedKey) +} + +func BenchmarkRS384Signing(b *testing.B) { + key, _ := ioutil.ReadFile("test/sample_key") + parsedKey, err := jwt.ParseRSAPrivateKeyFromPEM(key) + if err != nil { + b.Fatal(err) + } + + benchmarkSigning(b, jwt.SigningMethodRS384, parsedKey) +} + +func BenchmarkRS512Signing(b *testing.B) { + key, _ := ioutil.ReadFile("test/sample_key") + parsedKey, err := jwt.ParseRSAPrivateKeyFromPEM(key) + if err != nil { + b.Fatal(err) + } + + benchmarkSigning(b, jwt.SigningMethodRS512, parsedKey) +} diff --git a/vendor/github.com/dgrijalva/jwt-go/rsa_utils.go b/vendor/github.com/dgrijalva/jwt-go/rsa_utils.go new file mode 100644 index 000000000..213a90dbb --- /dev/null +++ b/vendor/github.com/dgrijalva/jwt-go/rsa_utils.go @@ -0,0 +1,69 @@ +package jwt + +import ( + "crypto/rsa" + "crypto/x509" + "encoding/pem" + "errors" +) + +var ( + ErrKeyMustBePEMEncoded = errors.New("Invalid Key: Key must be PEM encoded PKCS1 or PKCS8 private key") + ErrNotRSAPrivateKey = errors.New("Key is not a valid RSA private key") + ErrNotRSAPublicKey = errors.New("Key is not a valid RSA public key") +) + +// Parse PEM encoded PKCS1 or PKCS8 private key +func ParseRSAPrivateKeyFromPEM(key []byte) (*rsa.PrivateKey, error) { + var err error + + // Parse PEM block + var block *pem.Block + if block, _ = pem.Decode(key); block == nil { + return nil, ErrKeyMustBePEMEncoded + } + + var parsedKey interface{} + if parsedKey, err = x509.ParsePKCS1PrivateKey(block.Bytes); err != nil { + if parsedKey, err = x509.ParsePKCS8PrivateKey(block.Bytes); err != nil { + return nil, err + } + } + + var pkey *rsa.PrivateKey + var ok bool + if pkey, ok = parsedKey.(*rsa.PrivateKey); !ok { + return nil, ErrNotRSAPrivateKey + } + + return pkey, nil +} + +// Parse PEM encoded PKCS1 or PKCS8 public key +func ParseRSAPublicKeyFromPEM(key []byte) (*rsa.PublicKey, error) { + var err error + + // Parse PEM block + var block *pem.Block + if block, _ = pem.Decode(key); block == nil { + return nil, ErrKeyMustBePEMEncoded + } + + // Parse the key + var parsedKey interface{} + if parsedKey, err = x509.ParsePKIXPublicKey(block.Bytes); err != nil { + if cert, err := x509.ParseCertificate(block.Bytes); err == nil { + parsedKey = cert.PublicKey + } else { + return nil, err + } + } + + var pkey *rsa.PublicKey + var ok bool + if pkey, ok = parsedKey.(*rsa.PublicKey); !ok { + return nil, ErrNotRSAPublicKey + } + + return pkey, nil +} diff --git a/vendor/github.com/dgrijalva/jwt-go/signing_method.go b/vendor/github.com/dgrijalva/jwt-go/signing_method.go new file mode 100644 index 000000000..ed1f212b2 --- /dev/null +++ b/vendor/github.com/dgrijalva/jwt-go/signing_method.go @@ -0,0 +1,35 @@ +package jwt + +import ( + "sync" +) + +var signingMethods = map[string]func() SigningMethod{} +var signingMethodLock = new(sync.RWMutex) + +// Implement SigningMethod to add new methods for signing or verifying tokens. +type SigningMethod interface { + Verify(signingString, signature string, key interface{}) error // Returns nil if signature is valid + Sign(signingString string, key interface{}) (string, error) // Returns encoded signature or error + Alg() string // returns the alg identifier for this method (example: 'HS256') +} + +// Register the "alg" name and a factory function for signing method. +// This is typically done during init() in the method's implementation +func RegisterSigningMethod(alg string, f func() SigningMethod) { + signingMethodLock.Lock() + defer signingMethodLock.Unlock() + + signingMethods[alg] = f +} + +// Get a signing method from an "alg" string +func GetSigningMethod(alg string) (method SigningMethod) { + signingMethodLock.RLock() + defer signingMethodLock.RUnlock() + + if methodF, ok := signingMethods[alg]; ok { + method = methodF() + } + return +} diff --git a/vendor/github.com/dgrijalva/jwt-go/test/ec256-private.pem b/vendor/github.com/dgrijalva/jwt-go/test/ec256-private.pem new file mode 100644 index 000000000..a6882b3e5 --- /dev/null +++ b/vendor/github.com/dgrijalva/jwt-go/test/ec256-private.pem @@ -0,0 +1,5 @@ +-----BEGIN EC PRIVATE KEY----- +MHcCAQEEIAh5qA3rmqQQuu0vbKV/+zouz/y/Iy2pLpIcWUSyImSwoAoGCCqGSM49 +AwEHoUQDQgAEYD54V/vp+54P9DXarYqx4MPcm+HKRIQzNasYSoRQHQ/6S6Ps8tpM +cT+KvIIC8W/e9k0W7Cm72M1P9jU7SLf/vg== +-----END EC PRIVATE KEY----- diff --git a/vendor/github.com/dgrijalva/jwt-go/test/ec256-public.pem b/vendor/github.com/dgrijalva/jwt-go/test/ec256-public.pem new file mode 100644 index 000000000..7191361e7 --- /dev/null +++ b/vendor/github.com/dgrijalva/jwt-go/test/ec256-public.pem @@ -0,0 +1,4 @@ +-----BEGIN PUBLIC KEY----- +MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEYD54V/vp+54P9DXarYqx4MPcm+HK +RIQzNasYSoRQHQ/6S6Ps8tpMcT+KvIIC8W/e9k0W7Cm72M1P9jU7SLf/vg== +-----END PUBLIC KEY----- diff --git a/vendor/github.com/dgrijalva/jwt-go/test/ec384-private.pem b/vendor/github.com/dgrijalva/jwt-go/test/ec384-private.pem new file mode 100644 index 000000000..a86c823e5 --- /dev/null +++ b/vendor/github.com/dgrijalva/jwt-go/test/ec384-private.pem @@ -0,0 +1,6 @@ +-----BEGIN EC PRIVATE KEY----- +MIGkAgEBBDCaCvMHKhcG/qT7xsNLYnDT7sE/D+TtWIol1ROdaK1a564vx5pHbsRy +SEKcIxISi1igBwYFK4EEACKhZANiAATYa7rJaU7feLMqrAx6adZFNQOpaUH/Uylb +ZLriOLON5YFVwtVUpO1FfEXZUIQpptRPtc5ixIPY658yhBSb6irfIJUSP9aYTflJ +GKk/mDkK4t8mWBzhiD5B6jg9cEGhGgA= +-----END EC PRIVATE KEY----- diff --git a/vendor/github.com/dgrijalva/jwt-go/test/ec384-public.pem b/vendor/github.com/dgrijalva/jwt-go/test/ec384-public.pem new file mode 100644 index 000000000..e80d00564 --- /dev/null +++ b/vendor/github.com/dgrijalva/jwt-go/test/ec384-public.pem @@ -0,0 +1,5 @@ +-----BEGIN PUBLIC KEY----- +MHYwEAYHKoZIzj0CAQYFK4EEACIDYgAE2Gu6yWlO33izKqwMemnWRTUDqWlB/1Mp +W2S64jizjeWBVcLVVKTtRXxF2VCEKabUT7XOYsSD2OufMoQUm+oq3yCVEj/WmE35 +SRipP5g5CuLfJlgc4Yg+Qeo4PXBBoRoA +-----END PUBLIC KEY----- diff --git a/vendor/github.com/dgrijalva/jwt-go/test/ec512-private.pem b/vendor/github.com/dgrijalva/jwt-go/test/ec512-private.pem new file mode 100644 index 000000000..213afaf13 --- /dev/null +++ b/vendor/github.com/dgrijalva/jwt-go/test/ec512-private.pem @@ -0,0 +1,7 @@ +-----BEGIN EC PRIVATE KEY----- +MIHcAgEBBEIB0pE4uFaWRx7t03BsYlYvF1YvKaBGyvoakxnodm9ou0R9wC+sJAjH +QZZJikOg4SwNqgQ/hyrOuDK2oAVHhgVGcYmgBwYFK4EEACOhgYkDgYYABAAJXIuw +12MUzpHggia9POBFYXSxaOGKGbMjIyDI+6q7wi7LMw3HgbaOmgIqFG72o8JBQwYN +4IbXHf+f86CRY1AA2wHzbHvt6IhkCXTNxBEffa1yMUgu8n9cKKF2iLgyQKcKqW33 +8fGOw/n3Rm2Yd/EB56u2rnD29qS+nOM9eGS+gy39OQ== +-----END EC PRIVATE KEY----- diff --git a/vendor/github.com/dgrijalva/jwt-go/test/ec512-public.pem b/vendor/github.com/dgrijalva/jwt-go/test/ec512-public.pem new file mode 100644 index 000000000..02ea02203 --- /dev/null +++ b/vendor/github.com/dgrijalva/jwt-go/test/ec512-public.pem @@ -0,0 +1,6 @@ +-----BEGIN PUBLIC KEY----- +MIGbMBAGByqGSM49AgEGBSuBBAAjA4GGAAQACVyLsNdjFM6R4IImvTzgRWF0sWjh +ihmzIyMgyPuqu8IuyzMNx4G2jpoCKhRu9qPCQUMGDeCG1x3/n/OgkWNQANsB82x7 +7eiIZAl0zcQRH32tcjFILvJ/XCihdoi4MkCnCqlt9/HxjsP590ZtmHfxAeertq5w +9vakvpzjPXhkvoMt/Tk= +-----END PUBLIC KEY----- diff --git a/vendor/github.com/dgrijalva/jwt-go/test/helpers.go b/vendor/github.com/dgrijalva/jwt-go/test/helpers.go new file mode 100644 index 000000000..f84c3ef63 --- /dev/null +++ b/vendor/github.com/dgrijalva/jwt-go/test/helpers.go @@ -0,0 +1,42 @@ +package test + +import ( + "crypto/rsa" + "github.com/dgrijalva/jwt-go" + "io/ioutil" +) + +func LoadRSAPrivateKeyFromDisk(location string) *rsa.PrivateKey { + keyData, e := ioutil.ReadFile(location) + if e != nil { + panic(e.Error()) + } + key, e := jwt.ParseRSAPrivateKeyFromPEM(keyData) + if e != nil { + panic(e.Error()) + } + return key +} + +func LoadRSAPublicKeyFromDisk(location string) *rsa.PublicKey { + keyData, e := ioutil.ReadFile(location) + if e != nil { + panic(e.Error()) + } + key, e := jwt.ParseRSAPublicKeyFromPEM(keyData) + if e != nil { + panic(e.Error()) + } + return key +} + +func MakeSampleToken(c jwt.Claims, key interface{}) string { + token := jwt.NewWithClaims(jwt.SigningMethodRS256, c) + s, e := token.SignedString(key) + + if e != nil { + panic(e.Error()) + } + + return s +} diff --git a/vendor/github.com/dgrijalva/jwt-go/test/hmacTestKey b/vendor/github.com/dgrijalva/jwt-go/test/hmacTestKey new file mode 100644 index 000000000..435b8ddb3 --- /dev/null +++ b/vendor/github.com/dgrijalva/jwt-go/test/hmacTestKey @@ -0,0 +1 @@ +#5K+���~ew{��Z�(��T�(����P.���Z��G��wb="=.!r.O�͚�gЀ� \ No newline at end of file diff --git a/vendor/github.com/dgrijalva/jwt-go/test/sample_key b/vendor/github.com/dgrijalva/jwt-go/test/sample_key new file mode 100644 index 000000000..abdbade31 --- /dev/null +++ b/vendor/github.com/dgrijalva/jwt-go/test/sample_key @@ -0,0 +1,27 @@ +-----BEGIN RSA PRIVATE KEY----- +MIIEowIBAAKCAQEA4f5wg5l2hKsTeNem/V41fGnJm6gOdrj8ym3rFkEU/wT8RDtn +SgFEZOQpHEgQ7JL38xUfU0Y3g6aYw9QT0hJ7mCpz9Er5qLaMXJwZxzHzAahlfA0i +cqabvJOMvQtzD6uQv6wPEyZtDTWiQi9AXwBpHssPnpYGIn20ZZuNlX2BrClciHhC +PUIIZOQn/MmqTD31jSyjoQoV7MhhMTATKJx2XrHhR+1DcKJzQBSTAGnpYVaqpsAR +ap+nwRipr3nUTuxyGohBTSmjJ2usSeQXHI3bODIRe1AuTyHceAbewn8b462yEWKA +Rdpd9AjQW5SIVPfdsz5B6GlYQ5LdYKtznTuy7wIDAQABAoIBAQCwia1k7+2oZ2d3 +n6agCAbqIE1QXfCmh41ZqJHbOY3oRQG3X1wpcGH4Gk+O+zDVTV2JszdcOt7E5dAy +MaomETAhRxB7hlIOnEN7WKm+dGNrKRvV0wDU5ReFMRHg31/Lnu8c+5BvGjZX+ky9 +POIhFFYJqwCRlopGSUIxmVj5rSgtzk3iWOQXr+ah1bjEXvlxDOWkHN6YfpV5ThdE +KdBIPGEVqa63r9n2h+qazKrtiRqJqGnOrHzOECYbRFYhexsNFz7YT02xdfSHn7gM +IvabDDP/Qp0PjE1jdouiMaFHYnLBbgvlnZW9yuVf/rpXTUq/njxIXMmvmEyyvSDn +FcFikB8pAoGBAPF77hK4m3/rdGT7X8a/gwvZ2R121aBcdPwEaUhvj/36dx596zvY +mEOjrWfZhF083/nYWE2kVquj2wjs+otCLfifEEgXcVPTnEOPO9Zg3uNSL0nNQghj +FuD3iGLTUBCtM66oTe0jLSslHe8gLGEQqyMzHOzYxNqibxcOZIe8Qt0NAoGBAO+U +I5+XWjWEgDmvyC3TrOSf/KCGjtu0TSv30ipv27bDLMrpvPmD/5lpptTFwcxvVhCs +2b+chCjlghFSWFbBULBrfci2FtliClOVMYrlNBdUSJhf3aYSG2Doe6Bgt1n2CpNn +/iu37Y3NfemZBJA7hNl4dYe+f+uzM87cdQ214+jrAoGAXA0XxX8ll2+ToOLJsaNT +OvNB9h9Uc5qK5X5w+7G7O998BN2PC/MWp8H+2fVqpXgNENpNXttkRm1hk1dych86 +EunfdPuqsX+as44oCyJGFHVBnWpm33eWQw9YqANRI+pCJzP08I5WK3osnPiwshd+ +hR54yjgfYhBFNI7B95PmEQkCgYBzFSz7h1+s34Ycr8SvxsOBWxymG5zaCsUbPsL0 +4aCgLScCHb9J+E86aVbbVFdglYa5Id7DPTL61ixhl7WZjujspeXZGSbmq0Kcnckb +mDgqkLECiOJW2NHP/j0McAkDLL4tysF8TLDO8gvuvzNC+WQ6drO2ThrypLVZQ+ry +eBIPmwKBgEZxhqa0gVvHQG/7Od69KWj4eJP28kq13RhKay8JOoN0vPmspXJo1HY3 +CKuHRG+AP579dncdUnOMvfXOtkdM4vk0+hWASBQzM9xzVcztCa+koAugjVaLS9A+ +9uQoqEeVNTckxx0S2bYevRy7hGQmUJTyQm3j1zEUR5jpdbL83Fbq +-----END RSA PRIVATE KEY----- diff --git a/vendor/github.com/dgrijalva/jwt-go/test/sample_key.pub b/vendor/github.com/dgrijalva/jwt-go/test/sample_key.pub new file mode 100644 index 000000000..03dc982ac --- /dev/null +++ b/vendor/github.com/dgrijalva/jwt-go/test/sample_key.pub @@ -0,0 +1,9 @@ +-----BEGIN PUBLIC KEY----- +MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA4f5wg5l2hKsTeNem/V41 +fGnJm6gOdrj8ym3rFkEU/wT8RDtnSgFEZOQpHEgQ7JL38xUfU0Y3g6aYw9QT0hJ7 +mCpz9Er5qLaMXJwZxzHzAahlfA0icqabvJOMvQtzD6uQv6wPEyZtDTWiQi9AXwBp +HssPnpYGIn20ZZuNlX2BrClciHhCPUIIZOQn/MmqTD31jSyjoQoV7MhhMTATKJx2 +XrHhR+1DcKJzQBSTAGnpYVaqpsARap+nwRipr3nUTuxyGohBTSmjJ2usSeQXHI3b +ODIRe1AuTyHceAbewn8b462yEWKARdpd9AjQW5SIVPfdsz5B6GlYQ5LdYKtznTuy +7wIDAQAB +-----END PUBLIC KEY----- diff --git a/vendor/github.com/dgrijalva/jwt-go/token.go b/vendor/github.com/dgrijalva/jwt-go/token.go new file mode 100644 index 000000000..d637e0867 --- /dev/null +++ b/vendor/github.com/dgrijalva/jwt-go/token.go @@ -0,0 +1,108 @@ +package jwt + +import ( + "encoding/base64" + "encoding/json" + "strings" + "time" +) + +// TimeFunc provides the current time when parsing token to validate "exp" claim (expiration time). +// You can override it to use another time value. This is useful for testing or if your +// server uses a different time zone than your tokens. +var TimeFunc = time.Now + +// Parse methods use this callback function to supply +// the key for verification. The function receives the parsed, +// but unverified Token. This allows you to use properties in the +// Header of the token (such as `kid`) to identify which key to use. +type Keyfunc func(*Token) (interface{}, error) + +// A JWT Token. Different fields will be used depending on whether you're +// creating or parsing/verifying a token. +type Token struct { + Raw string // The raw token. Populated when you Parse a token + Method SigningMethod // The signing method used or to be used + Header map[string]interface{} // The first segment of the token + Claims Claims // The second segment of the token + Signature string // The third segment of the token. Populated when you Parse a token + Valid bool // Is the token valid? Populated when you Parse/Verify a token +} + +// Create a new Token. Takes a signing method +func New(method SigningMethod) *Token { + return NewWithClaims(method, MapClaims{}) +} + +func NewWithClaims(method SigningMethod, claims Claims) *Token { + return &Token{ + Header: map[string]interface{}{ + "typ": "JWT", + "alg": method.Alg(), + }, + Claims: claims, + Method: method, + } +} + +// Get the complete, signed token +func (t *Token) SignedString(key interface{}) (string, error) { + var sig, sstr string + var err error + if sstr, err = t.SigningString(); err != nil { + return "", err + } + if sig, err = t.Method.Sign(sstr, key); err != nil { + return "", err + } + return strings.Join([]string{sstr, sig}, "."), nil +} + +// Generate the signing string. This is the +// most expensive part of the whole deal. Unless you +// need this for something special, just go straight for +// the SignedString. +func (t *Token) SigningString() (string, error) { + var err error + parts := make([]string, 2) + for i, _ := range parts { + var jsonValue []byte + if i == 0 { + if jsonValue, err = json.Marshal(t.Header); err != nil { + return "", err + } + } else { + if jsonValue, err = json.Marshal(t.Claims); err != nil { + return "", err + } + } + + parts[i] = EncodeSegment(jsonValue) + } + return strings.Join(parts, "."), nil +} + +// Parse, validate, and return a token. +// keyFunc will receive the parsed token and should return the key for validating. +// If everything is kosher, err will be nil +func Parse(tokenString string, keyFunc Keyfunc) (*Token, error) { + return new(Parser).Parse(tokenString, keyFunc) +} + +func ParseWithClaims(tokenString string, claims Claims, keyFunc Keyfunc) (*Token, error) { + return new(Parser).ParseWithClaims(tokenString, claims, keyFunc) +} + +// Encode JWT specific base64url encoding with padding stripped +func EncodeSegment(seg []byte) string { + return strings.TrimRight(base64.URLEncoding.EncodeToString(seg), "=") +} + +// Decode JWT specific base64url encoding with padding stripped +func DecodeSegment(seg string) ([]byte, error) { + if l := len(seg) % 4; l > 0 { + seg += strings.Repeat("=", 4-l) + } + + return base64.URLEncoding.DecodeString(seg) +}