auth

Documentation

Overview

auth package contains helper functions related to internal jwt and external oauth2 authentication.

Index

• func CreateGithubAppClient(transportCtx context.Context, options *GithubAppOptions) (*github.Client, error)
• func CreateGithubWebhookClient(awsConfig aws.Config, transportCtx context.Context, githubSecretARN string) (*webhook.Webhook, error)
• func CreateJWT(options *JwtOptions, id, provider, username, avatarUrl string) (string, error)
• func CreateOAuthOptions(awsConfig aws.Config, transportCtx context.Context, oauthSecretARN string, ...) (*oauth2.Config, error)
• type GithubAppOptions
  • func CreateGithubAppOptions(awsConfig aws.Config, transportCtx context.Context, githubSecretARN string) (*GithubAppOptions, error)
• type JwtOptions
  • func CreateJwtOptions(awsConfig aws.Config, transportCtx context.Context, jwtSecretARN string, ...) (*JwtOptions, error)
• type UserClaims
  • func ParseJWT(options *JwtOptions, token string) (*UserClaims, error)

Functions

func CreateGithubAppClient

func CreateGithubAppClient(transportCtx context.Context, options *GithubAppOptions) (*github.Client, error)

CreateGithubAppClient creates a one time github app client from the provided app options. The client works for 10 minutes, afterwards the jwt expires and a new one must be created.

func CreateGithubWebhookClient

func CreateGithubWebhookClient(awsConfig aws.Config, transportCtx context.Context, githubSecretARN string) (*webhook.Webhook, error)

CreateGithubWebhookClient fetches the githubSecret containing "webhook_secret" from SecretsManager and creates a github app client. The calling instance needs to have IAM access to the action "secretsmanager:GetSecretValue" on the provided githubSecret.

func CreateJWT

func CreateJWT(options *JwtOptions, id, provider, username, avatarUrl string) (string, error)

CreateJWT generates a jwt token based on the input options.

func CreateOAuthOptions

func CreateOAuthOptions(awsConfig aws.Config, transportCtx context.Context, oauthSecretARN string, endpoint oauth2.Endpoint, redirectUri string, scopes []string) (*oauth2.Config, error)

CreateOAuthOptions fetches the oauthSecret containing "client_id" and "client_secret" from SecretsManager and constructs the oauth.Config. The calling instance needs to have IAM access to the action "secretsmanager:GetSecretValue" on the provided oauthSecretARN.

Types

type GithubAppOptions

type GithubAppOptions struct {
	AppId     string
	AppSecret *rsa.PrivateKey
}

func CreateGithubAppOptions

func CreateGithubAppOptions(awsConfig aws.Config, transportCtx context.Context, githubSecretARN string) (*GithubAppOptions, error)

CreateGithubAppOptions fetches the githubSecret containing "app_id" and "app_secret" from SecretsManager and creates github app options. The calling instance needs to have IAM access to the action "secretsmanager:GetSecretValue" on the provided githubSecret.

type JwtOptions

type JwtOptions struct {
	Secret string
	TTL    time.Duration
}

func CreateJwtOptions

func CreateJwtOptions(awsConfig aws.Config, transportCtx context.Context, jwtSecretARN string, ttl time.Duration) (*JwtOptions, error)

CreateJwtOptions fetches the jwtSecret containing "secret" from SecretsManager and constructs the auth.JwtOptions. The calling instance needs to have IAM access to the action "secretsmanager:GetSecretValue" on the provided jwtSecretARN.

type UserClaims

type UserClaims struct {
	Id        string `json:"id"`
	Provider  string `json:"provider"`
	Username  string `json:"username"`
	AvatarURL string `json:"avatar_url"`
	jwt.RegisteredClaims
}

func ParseJWT

func ParseJWT(options *JwtOptions, token string) (*UserClaims, error)

ParseJWT verifies the jwt string based on the provided options. It returns the user claims or an error if invalid.