Athenz authorizer is a library to cache the policies of Athenz to authorizer authentication and authorization check of user request.
To initialize authorizer.
// Initialize authorizerd
daemon, err := authorizerd.New(
authorizerd.WithAthenzURL("www.athenz.io"), // set athenz URL
authorizerd.WithAthenzDomains("domain1", "domain2" ... "domain N"), // set athenz domains
authorizerd.WithPubkeyRefreshPeriod(time.Hour * 24), // set athenz public key refresh period
authorizerd.WithPolicyRefreshPeriod(time.Hour), // set policy refresh period
)
if err != nil {
// cannot initialize authorizer daemon
}
// Start authorizer daemon
ctx := context.Background() // user can control authorizer daemon lifetime using this context
errs := daemon.Start(ctx)
go func() {
err := <-errs
// user should handle errors return from the daemon
}()
// Verify role token
if err := daemon.VerifyRoleToken(ctx, roleTok, act, res); err != nil {
// token not authorized
}
// Verified results are returned
principal, err := daemon.AuthorizeRoleToken(ctx, roleTok, act, res)
if err != nil {
name := principal.GetName()
}To do the authentication and authorization check, the user needs to specify which domain data to be cache. The authorizer will periodically refresh the policies and Athenz public key data to verify and decode the domain data. The verified domain data will cache into the memory, and use for authentication and authorization check.
The authorizer contains two sub-module, Athenz public key daemon (pubkeyd) and Athenz policy daemon (policyd).
Athenz public key daemon (pubkeyd) is responsible for periodically update the Athenz public key data from Athenz server to verify the policy data received from Athenz policy daemon and verify the role token.
Athenz policy daemon (policyd) is responsible for periodically update the policy data of specified Athenz domain from Athenz server. The received policy data will be verified using the public key got from pubkeyd, and cache into memory. Whenever user requesting for the access check, the verification check will be used instead of asking Athenz server every time.
The authorizer uses functional options pattern to initialize the instance. All the options are defined here.
| Option name | Description | Default Value | Required | Example |
|---|---|---|---|---|
| AthenzURL | The Athenz server URL | athenz.io/zts/v1 | Yes | "athenz.io/zts/v1" |
| AthenzDomains | Athenz domain names that contain the RBAC policies | [] | Yes | "domName1", "domName2" |
| HTTPClient | The HTTP client for connecting to Athenz server | http.Client{ Timeout: 30 * time.Second } | No | http.DefaultClient |
| CacheExp | The TTL of the success cache | 1 Minute | No | 1 * time.Minute |
| Enable/DisablePubkeyd | Run public key daemon or not | true | No | |
| PubkeySysAuthDomain | System authority domain name to retrieve Athenz public key data | sys.auth | No | "sys.auth" |
| PubkeyRefreshPeriod | Period to refresh the Athenz public key data | 24 Hours | No | "24h" |
| PubkeyETagExpiry | ETag cache TTL of Athenz public key data | 168 Hours (1 Week) | No | "168h" |
| PubkeyETagPurgePeriod | ETag cache purge duration | 84 Hours | No | "84h" |
| PubkeyRetryDelay | Delay of next retry on request failed | 1 Minute | No | "1m" |
| Enable/DisablePolicyd | Run policy daemon or not | true | No | |
| PolicyExpiryMargin | Update the policy by a margin duration before the policy actually expires | 3 Hours | No | "3h" |
| PolicyRefreshPeriod | Period to refresh the Athenz policies | 30 Minutes | No | "30m" |
| PolicyPurgePeriod | Policy cache purge duration | 1 Hours | No | "1h" |
| PolicyRetryDelay | Delay of next retry on request fail | 1 Minute | No | "1m" |
| PolicyRetryAttempts | Maximum retry attempts on request fail | 2 | No | 2 |
| Enable/DisableJwkd | Run JWK daemon or not | true | No | |
| JwkRefreshPeriod | Period to refresh the Athenz JWK | 24 Hours | No | "24h" |
| JwkRetryDelay | Delay of next retry on request fail | 1 Minute | No | "1m" |
| jwkURLs | URL to get jwk other than AthenzURL | [] | No | "http://domain1/jwks", "http://domain2/jwks" |
| AccessTokenParam | Use access token verification, details: AccessTokenParam | Same as AccessTokenParam | No | {} |
| Enable/DisableRoleToken | Use role token verification or not | true | No | |
| RoleAuthHeader | The HTTP header to extract role token | Athenz-Role-Auth | No | "Athenz-Role-Auth" |
| Enable/DisableRoleCert | Use role certificate verification or not | true | No | |
| RoleCertURIPrefix | Extract role from role certificate | athenz://role/ | No | "athenz://role/" |
| Option name | Description | Default Value | Required | Example |
|---|---|---|---|---|
| enable | Use access token verification or not | true | No | true |
| verifyCertThumbprint | Use certificate bound access token verification | true | No | true |
| certBackdateDur | Backdate duration of the issue time of the certificate | 1 Hour | No | "1h" |
| certOffsetDur | Offset window to accept access token with a mismatching certificate thumbprint | 1 Hour | No | "1h" |
| verifyClientID | Use authorized client ID verification | false | No | false |
| authorizedClientIDs | Authorized client ID to certificate common name map | nil | No | { "atClientID": { "certCN1", "certCN2" } } |
Copyright (C) 2018 Yahoo Japan Corporation Athenz team.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.This project requires contributors to agree to a Contributor License Agreement (CLA).
Note that only for contributions to the athenz-authorizer repository on the GitHub, the contributors of them shall be deemed to have agreed to the CLA without individual written agreements.
- Releases