unistack-org/micro
4
0
Fork 3
Code Issues 19 Pull Requests 1 Actions Packages Projects Releases 259 Wiki Activity

auth: rename auth.Namespace to auth.Issuer (#1710)

Browse Source
This commit is contained in:
ben-toogood 2020-06-17 12:26:27 +01:00 committed by GitHub
parent 2efb459c66
commit 9d3365c4be
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
6 changed files with 31 additions and 31 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
auth/default.go
View File

@ -53,7 +53,7 @@ func (n *noop) Generate(id string, opts ...GenerateOption) (*Account, error) {
Secret: options.Secret, Secret: options.Secret,
Metadata: options.Metadata, Metadata: options.Metadata,
Scopes: options.Scopes, Scopes: options.Scopes,
Issuer: n.Options().Namespace, Issuer: n.Options().Issuer,
}, nil }, nil
} }
@ -79,7 +79,7 @@ func (n *noop) Verify(acc *Account, res *Resource, opts ...VerifyOption) error {
// Inspect a token // Inspect a token
func (n *noop) Inspect(token string) (*Account, error) { func (n *noop) Inspect(token string) (*Account, error) {
return &Account{ID: uuid.New().String(), Issuer: n.Options().Namespace}, nil return &Account{ID: uuid.New().String(), Issuer: n.Options().Issuer}, nil
} }
// Token generation using an account id and secret // Token generation using an account id and secret

2
auth/jwt/jwt.go
View File

@ -56,7 +56,7 @@ func (j *jwt) Generate(id string, opts ...auth.GenerateOption) (*auth.Account, e
Type: options.Type, Type: options.Type,
Scopes: options.Scopes, Scopes: options.Scopes,
Metadata: options.Metadata, Metadata: options.Metadata,
Issuer: j.Options().Namespace, Issuer: j.Options().Issuer,
} }
// generate a JWT secret which can be provided to the Token() method // generate a JWT secret which can be provided to the Token() method

10
auth/options.go
View File

@ -22,8 +22,8 @@ func NewOptions(opts ...Option) Options {
} }
type Options struct { type Options struct {
// Namespace the service belongs to // Issuer of the service's account
Namespace string Issuer string
// ID is the services auth ID // ID is the services auth ID
ID string ID string
// Secret is used to authenticate the service // Secret is used to authenticate the service
@ -55,10 +55,10 @@ func Addrs(addrs ...string) Option {
} }
} }
// Namespace the service belongs to // Issuer of the services account
func Namespace(n string) Option { func Issuer(i string) Option {
return func(o *Options) { return func(o *Options) {
o.Namespace = n o.Issuer = i
} }
} }

10
config/cmd/cmd.go
View File

@ -276,9 +276,9 @@ var (
Usage: "Account secret used for client authentication", Usage: "Account secret used for client authentication",
}, },
&cli.StringFlag{ &cli.StringFlag{
Name: "auth_namespace", Name: "service_namespace",
EnvVars: []string{"MICRO_AUTH_NAMESPACE"}, EnvVars: []string{"MICRO_NAMESPACE"},
Usage: "Namespace for the services auth account", Usage: "Namespace the service is operating in",
Value: "go.micro", Value: "go.micro",
}, },
&cli.StringFlag{ &cli.StringFlag{
@ -540,8 +540,8 @@ func (c *cmd) Before(ctx *cli.Context) error {
if len(ctx.String("auth_private_key")) > 0 { if len(ctx.String("auth_private_key")) > 0 {
authOpts = append(authOpts, auth.PrivateKey(ctx.String("auth_private_key"))) authOpts = append(authOpts, auth.PrivateKey(ctx.String("auth_private_key")))
} }
if len(ctx.String("auth_namespace")) > 0 { if len(ctx.String("service_namespace")) > 0 {
authOpts = append(authOpts, auth.Namespace(ctx.String("auth_namespace"))) authOpts = append(authOpts, auth.Issuer(ctx.String("service_namespace")))
} }
if name := ctx.String("auth_provider"); len(name) > 0 { if name := ctx.String("auth_provider"); len(name) > 0 {
p, ok := DefaultAuthProviders[name] p, ok := DefaultAuthProviders[name]

4
util/wrapper/wrapper.go
View File

@ -158,7 +158,7 @@ func (a *authWrapper) Call(ctx context.Context, req client.Request, rsp interfac
// set the namespace header if it has not been set (e.g. on a service to service request) // set the namespace header if it has not been set (e.g. on a service to service request)
if _, ok := metadata.Get(ctx, "Micro-Namespace"); !ok { if _, ok := metadata.Get(ctx, "Micro-Namespace"); !ok {
ctx = metadata.Set(ctx, "Micro-Namespace", aa.Options().Namespace) ctx = metadata.Set(ctx, "Micro-Namespace", aa.Options().Issuer)
} }
// check to see if we have a valid access token // check to see if we have a valid access token
@ -205,7 +205,7 @@ func AuthHandler(fn func() auth.Auth) server.HandlerWrapper {
// Extract the namespace header // Extract the namespace header
ns, ok := metadata.Get(ctx, "Micro-Namespace") ns, ok := metadata.Get(ctx, "Micro-Namespace")
if !ok { if !ok {
ns = a.Options().Namespace ns = a.Options().Issuer
ctx = metadata.Set(ctx, "Micro-Namespace", ns) ctx = metadata.Set(ctx, "Micro-Namespace", ns)
} }

32
util/wrapper/wrapper_test.go
View File

@ -61,7 +61,7 @@ func TestWrapper(t *testing.T) {
type testAuth struct { type testAuth struct {
verifyCount int verifyCount int
inspectCount int inspectCount int
namespace string issuer string
inspectAccount *auth.Account inspectAccount *auth.Account
verifyError error verifyError error
@ -79,7 +79,7 @@ func (a *testAuth) Inspect(token string) (*auth.Account, error) {
} }
func (a *testAuth) Options() auth.Options { func (a *testAuth) Options() auth.Options {
return auth.Options{Namespace: a.namespace} return auth.Options{Issuer: a.issuer}
} }
type testRequest struct { type testRequest struct {
@ -171,10 +171,10 @@ func TestAuthHandler(t *testing.T) {
} }
}) })
// If the namespace header was not set on the request, the wrapper should set it to the auths // If the issuer header was not set on the request, the wrapper should set it to the auths
// own namespace // own issuer
t.Run("BlankNamespaceHeader", func(t *testing.T) { t.Run("BlankissuerHeader", func(t *testing.T) {
a := testAuth{namespace: "mynamespace"} a := testAuth{issuer: "myissuer"}
handler := AuthHandler(func() auth.Auth { handler := AuthHandler(func() auth.Auth {
return &a return &a
}) })
@ -189,17 +189,17 @@ func TestAuthHandler(t *testing.T) {
if err != nil { if err != nil {
t.Errorf("Expected nil error but got %v", err) t.Errorf("Expected nil error but got %v", err)
} }
if ns, _ := metadata.Get(inCtx, "Micro-Namespace"); ns != a.namespace { if ns, _ := metadata.Get(inCtx, "Micro-Namespace"); ns != a.issuer {
t.Errorf("Expected namespace to be set to %v but was %v", a.namespace, ns) t.Errorf("Expected issuer to be set to %v but was %v", a.issuer, ns)
} }
}) })
t.Run("ValidNamespaceHeader", func(t *testing.T) { t.Run("ValidissuerHeader", func(t *testing.T) {
a := testAuth{namespace: "mynamespace"} a := testAuth{issuer: "myissuer"}
handler := AuthHandler(func() auth.Auth { handler := AuthHandler(func() auth.Auth {
return &a return &a
}) })
inNs := "reqnamespace" inNs := "reqissuer"
inCtx := metadata.Set(context.TODO(), "Micro-Namespace", inNs) inCtx := metadata.Set(context.TODO(), "Micro-Namespace", inNs)
h := func(ctx context.Context, req server.Request, rsp interface{}) error { h := func(ctx context.Context, req server.Request, rsp interface{}) error {
inCtx = ctx inCtx = ctx
@ -211,7 +211,7 @@ func TestAuthHandler(t *testing.T) {
t.Errorf("Expected nil error but got %v", err) t.Errorf("Expected nil error but got %v", err)
} }
if ns, _ := metadata.Get(inCtx, "Micro-Namespace"); ns != inNs { if ns, _ := metadata.Get(inCtx, "Micro-Namespace"); ns != inNs {
t.Errorf("Expected namespace to remain as %v but was set to %v", inNs, ns) t.Errorf("Expected issuer to remain as %v but was set to %v", inNs, ns)
} }
}) })
@ -219,8 +219,8 @@ func TestAuthHandler(t *testing.T) {
// should be forbidden // should be forbidden
t.Run("InvalidAccountIssuer", func(t *testing.T) { t.Run("InvalidAccountIssuer", func(t *testing.T) {
a := testAuth{ a := testAuth{
namespace: "validnamespace", issuer: "validissuer",
inspectAccount: &auth.Account{Issuer: "invalidnamespace"}, inspectAccount: &auth.Account{Issuer: "invalidissuer"},
} }
handler := AuthHandler(func() auth.Auth { handler := AuthHandler(func() auth.Auth {
@ -235,8 +235,8 @@ func TestAuthHandler(t *testing.T) {
}) })
t.Run("ValidAccountIssuer", func(t *testing.T) { t.Run("ValidAccountIssuer", func(t *testing.T) {
a := testAuth{ a := testAuth{
namespace: "validnamespace", issuer: "validissuer",
inspectAccount: &auth.Account{Issuer: "validnamespace"}, inspectAccount: &auth.Account{Issuer: "validissuer"},
} }
handler := AuthHandler(func() auth.Auth { handler := AuthHandler(func() auth.Auth {