import "go.aporeto.io/midgard-lib/client"
Package midgardclient contains a client that can be used to retrieve an Aporeto JWT from various authentication sources.
client.go doc.go manager.go options.go utils.go
CredsToTLSConfig converts Crendential to *tlsConfig
ExtractJWTFromHeader extracts the JWT from the given http.Header.
func NormalizeAuth(c *types.MidgardClaims) (claims []string)
NormalizeAuth normalizes the response to a simple structure.
ParseCredentials parses the credential data.
UnsecureClaimsFromToken gets a token and returns the Aporeto claims contained inside. It is Unsecure in the sense that It doesn't verify the token signature, so the token must be first verified in order to use this function securely.
func VerifyToken(tokenString string, cert *x509.Certificate) (*types.MidgardClaims, error)
VerifyToken verifies the jwt locally using the given certificate.
VerifyTokenSignature verifies the jwt locally using the given certificate. Deprecated: VerifyTokenSignature is deprecated in favor of VerifyToken()
A Client allows to interract with a midgard server.
NewClient returns a new Client.
NewClientWithTLS returns a new Client configured with the given x509.CAPool.
Authentify authentifies the information included in the given token and returns a list of tag string containing the claims.
func (a *Client) IssueFromAWSSecurityToken(ctx context.Context, accessKeyID, secretAccessKey, token string, validity time.Duration, options ...Option) (string, error)
IssueFromAWSSecurityToken issues a Midgard jwt from a security token from amazon. If you don't pass anything, this function will try to retrieve the token using aws magic ip.
func (a *Client) IssueFromAporetoIdentityToken(ctx context.Context, token string, validity time.Duration, options ...Option) (string, error)
IssueFromAporetoIdentityToken issues a Midgard jwt from an existing one. This new token validity will be capped to the original expiration time and identity claims will be identical. This can be used to issued a token with restrictions without needing the original source of authentication.
func (a *Client) IssueFromAzureIdentityToken(ctx context.Context, token string, validity time.Duration, options ...Option) (string, error)
IssueFromAzureIdentityToken issues a Midgard jwt from a signed Azure identity document for the given validity duration.
func (a *Client) IssueFromCertificate(ctx context.Context, validity time.Duration, options ...Option) (string, error)
IssueFromCertificate issues a Midgard jwt from a certificate for the given validity duration.
func (a *Client) IssueFromGCPIdentityToken(ctx context.Context, token string, validity time.Duration, options ...Option) (string, error)
IssueFromGCPIdentityToken issues a Midgard jwt from a signed GCP identity document for the given validity duration.
func (a *Client) IssueFromGoogle(ctx context.Context, googleJWT string, validity time.Duration, options ...Option) (string, error)
IssueFromGoogle issues a Midgard jwt from a Google JWT for the given validity duration.
func (a *Client) IssueFromLDAP(ctx context.Context, info *ldaputils.LDAPInfo, namespace string, provider string, validity time.Duration, options ...Option) (string, error)
IssueFromLDAP issues a Midgard JWT from an LDAP config for the given validity duration.
func (a *Client) IssueFromOIDCStep1(ctx context.Context, namespace string, provider string, redirectURL string) (string, error)
IssueFromOIDCStep1 issues a Midgard jwt from a OICD provider. This is performing the first step to validate the issue requests and OIDC provider. It will return the OIDC auth endpoint
func (a *Client) IssueFromOIDCStep2(ctx context.Context, code string, state string, validity time.Duration, options ...Option) (string, error)
IssueFromOIDCStep2 issues a Midgard jwt from a OICD provider. This is performing the second step to to exchange the code for a Midgard HWT.
func (a *Client) IssueFromPCIdentityToken(ctx context.Context, token string, validity time.Duration, options ...Option) (string, error)
IssueFromPCIdentityToken issues a Midgard jwt from a PCC token.
func (a *Client) IssueFromSAMLStep1(ctx context.Context, namespace string, provider string, redirectURL string) (string, error)
IssueFromSAMLStep1 issues a Midgard jwt from a SAML provider. This is performing the first step to validate the issue requests and OIDC provider. It will return the OIDC auth endpoint
func (a *Client) IssueFromSAMLStep2(ctx context.Context, response string, state string, validity time.Duration, options ...Option) (string, error)
IssueFromSAMLStep2 issues a Midgard jwt from a SAML provider. This is performing the second step to to exchange the code for a Midgard HWT.
func (a *Client) IssueFromVince(ctx context.Context, account string, password string, otp string, validity time.Duration, options ...Option) (string, error)
IssueFromVince issues a Midgard jwt from a Vince for the given one time password and validity duration.
type Option func(*issueOpts)
An Option is the type of various options You can add the issue requests.
OptAudience passes the requested audience for the token. Using audience is deprecated. Switch to OptLimitAuthz.
OptOpaque passes opaque data that will be included in the JWT.
OptQuota sets the maximum time the issued token can be used.
OptRestrictNamespace asks for a restricted token on the given namespace.
OptRestrictNetworks asks for a restricted token on the given networks.
OptRestrictPermissions asks for a restricted token on the given permissions.
type TokenManager struct {
// contains filtered or unexported fields
}
A TokenManager issues an renew tokens periodically.
func NewMidgardTokenManager(url string, validity time.Duration, tlsConfig *tls.Config) *TokenManager
NewMidgardTokenManager returns a new TokenManager backed by midgard.
Issue issues a token.
func (m *TokenManager) Run(ctx context.Context, tokenCh chan string)
Run runs the token renewal job.
Package midgardclient imports 25 packages (graph) and is imported by 1 packages. Updated 2020-11-10. Refresh now. Tools for package owners.