oidcsdk

type Arguments []string

type Config struct {
	Issuer                   string
	AuthCodeLifespan         time.Duration
	AccessTokenLifespan      time.Duration
	RefreshTokenLifespan     time.Duration
	AccessTokenEntropy       int
	AuthorizationCodeEntropy int
	RefreshTokenEntropy      int
	StateParamMinimumEntropy int
	GlobalConsentRequired    bool
	PKCEPlainEnabled         bool
}

type ErrorFactory func(status uint8, code string, description string) IError

type ErrorStrategy func(err error, w http.ResponseWriter)

type IAccessTokenStrategy interface {
	GenerateAccessToken() (token string, signature string)
	SignAccessToken(token string) (signature string, err error)
}

type IAuthEPHandler interface {
	HandleAuthEP(ctx context.Context, requestContext IAuthenticationRequestContext) IError
}

type IAuthenticationRequestContext interface {
	IRequestContext
	GetUserSession() ISession
	SetUserSession(sess ISession)
	GetNonce() string
	GetResponseMode() string
	GetResponseType() Arguments
	SetRedirectURI(uri string)
	IssueAuthorizationCode(code string, signature string, expiry time.Time)
}

type IAuthorizationCodeStrategy interface {
	GenerateAuthCode() (code string, signature string)
	SignAuthCode(token string) (signature string, err error)
}

type IClient interface {
	GetID() string
	GetSecret() string
	IsPublic() bool
	GetIDTokenSigningAlg() jose.SignatureAlgorithm
	GetRedirectURIs() []string
	GetPostLogoutRedirectURIs() []string
	GetApprovedScopes() Arguments
	GetApprovedGrantTypes() Arguments
}

type IClientCredentialContext interface {
	GetClientID() string
	GetClientSecret() string
	SetClient(client IClient)
}

type IClientStore interface {
	GetClient(ctx context.Context, clientID string) (client IClient, err error)
	FetchClientProfile(ctx context.Context, clientID string) RequestProfile
}

type IError interface {
	error
	GetStatus() string
	GetReason() string
	GetStatusCode() int
	GetDescription() string
	GetDebugInfo() string
}

type IErrorWriter interface {
	WriteJsonError(pError IError, additionalValues url.Values, w http.ResponseWriter, r *http.Request) error
	WriteRedirectError(requestContext IAuthenticationRequestContext, w http.ResponseWriter, r *http.Request) error
	WriteBearerError(pError IError, additionalValues url.Values, w http.ResponseWriter, r *http.Request) error
}

type IIDTokenStrategy interface {
	GenerateIDToken(ctx context.Context, profile RequestProfile, client IClient, expiry time.Time,
		transactionClaims map[string]interface{}, tokens Tokens) (idToken string, err error)
}

type IIntrospectionEPHandler interface {
	HandleIntrospectionEP(ctx context.Context, requestContext IIntrospectionRequestContext) IError
}

type IIntrospectionRequestContext interface {
	IRevocationRequestContext
	GetProfile() RequestProfile
	SetProfile(profile RequestProfile)
	IsActive() bool
	SetActive(active bool)
	GetTokenType() string
	SetTokenType(tokenType string)
}

type IJWTValidator interface {
	ValidateOwnJWTToken(ctx context.Context, token string) (clientId string, username string, err error)
}

type IManager interface {
	ProcessAuthorizationEP(writer http.ResponseWriter, request *http.Request)
	ProcessTokenEP(writer http.ResponseWriter, request *http.Request)
	ProcessIntrospectionEP(writer http.ResponseWriter, request *http.Request)
	ProcessRevocationEP(writer http.ResponseWriter, request *http.Request)
	ProcessDiscoveryEP(writer http.ResponseWriter, request *http.Request)
	ProcessKeysEP(writer http.ResponseWriter, request *http.Request)
	ProcessUserInfoEP(writer http.ResponseWriter, request *http.Request)
	ProcessRPILogoutEP(writer http.ResponseWriter, request *http.Request)

	SetErrorStrategy(strategy ErrorStrategy)
}

type IPageResponseHandler interface {
	DisplayLogoutConsentPage(w http.ResponseWriter, r *http.Request)
	DisplayLogoutStatusPage(w http.ResponseWriter, r *http.Request)
	DisplayErrorPage(err error, w http.ResponseWriter, r *http.Request)
	DisplayLoginPage(w http.ResponseWriter, r *http.Request)
	DisplayConsentPage(w http.ResponseWriter, r *http.Request)
}

type IRPILogoutEPHandler interface {
	HandleRPILogoutEP(ctx context.Context, requestContext IRPILogoutRequestContext) IError
}

type IRPILogoutRequestContext interface {
	GetPostLogoutRedirectUri() string
	SetPostLogoutRedirectUri(uri string)
	GetIdTokenHint() string
	GetClient() IClient
	SetClient(id IClient)
	SetUsername(username string)
	GetUserName() string
	GetState() string
	GetCSRFToken() string
	GetUserSession() ISession
	SetUserSession(session ISession)
}

type IRefreshTokenStrategy interface {
	GenerateRefreshToken() (token string, signature string)
	SignRefreshToken(token string) (signature string, err error)
}

type IRequestContext interface {
	GetRequestID() string
	GetRequestedAt() time.Time
	GetState() string
	GetRedirectURI() string
	GetClientID() string
	GetRequestedScopes() Arguments
	GetRequestedAudience() Arguments
	GetClaims() map[string]interface{}
	GetClient() IClient
	SetClient(client IClient)
	GetProfile() RequestProfile
	SetProfile(profile RequestProfile)
	GetIssuedTokens() Tokens
	IssueAccessToken(token string, signature string, expiry time.Time)
	IssueRefreshToken(token string, signature string, expiry time.Time)
	IssueIDToken(token string)
	GetError() IError
	SetError(err IError)
	GetForm() *url.Values
}

type IRequestContextFactory interface {
	BuildTokenRequestContext(request *http.Request) (ITokenRequestContext, IError)
	BuildAuthorizationRequestContext(request *http.Request) (IAuthenticationRequestContext, IError)
	BuildRevocationRequestContext(request *http.Request) (IRevocationRequestContext, IError)
	BuildIntrospectionRequestContext(request *http.Request) (IIntrospectionRequestContext, IError)
	BuildUserInfoRequestContext(request *http.Request) (IUserInfoRequestContext, IError)
	BuildRPILogoutRequestContext(request *http.Request) (IRPILogoutRequestContext, IError)
}

type IResponseWriter interface {
	WriteTokenResponse(requestContext ITokenRequestContext, w http.ResponseWriter, r *http.Request) error
	WriteAuthorizationResponse(requestContext IAuthenticationRequestContext, w http.ResponseWriter, r *http.Request) error
	WriteIntrospectionResponse(requestContext IIntrospectionRequestContext, w http.ResponseWriter, r *http.Request) error
	WriteRevocationResponse(w http.ResponseWriter, r *http.Request) error
	WriteUserInfoResponse(requestContext IUserInfoRequestContext, w http.ResponseWriter, r *http.Request) error
	WriteRPILogoutResponse(requestContext IRPILogoutRequestContext, w http.ResponseWriter, r *http.Request)
}

type IRevocationEPHandler interface {
	HandleRevocationEP(ctx context.Context, requestContext IRevocationRequestContext) IError
}

type IRevocationRequestContext interface {
	GetRequestID() string
	GetRequestedAt() time.Time
	GetClientID() string
	GetToken() string
	GetTokenTypeHint() string
	SetClient(client IClient)
	GetClientSecret() string
	GetClient() IClient
	GetError() IError
	SetError(err IError)
	GetForm() *url.Values
}

type ISecretStore interface {
	GetAllSecrets(ctx context.Context) (*jose.JSONWebKeySet, error)
}

type ISession interface {
	GetUsername() string
	GetLoginTime() *time.Time
	IsConsentSubmitted() bool
	IsLoginDone() bool
	GetApprovedScopes() Arguments
	GetScope() string
	Logout()
	Save() error
}

type ISessionManager interface {
	RetrieveUserSession(w http.ResponseWriter, r *http.Request) (ISession, error)
}

type ITokenEPHandler interface {
	HandleTokenEP(ctx context.Context, requestContext ITokenRequestContext) IError
}

type ITokenRequestContext interface {
	IRequestContext
	GetRefreshToken() string
	GetPreviousRequestID() (id string)
	SetPreviousRequestID(id string)
	GetGrantType() string
	GetClientSecret() string
	GetAuthorizationCode() string
	GetUsername() string
	GetPassword() string
}

type ITokenSignatures interface {
	GetACSignature() string
	GetATSignature() string
	GetRTSignature() string
	GetACExpiry() time.Time
	GetATExpiry() time.Time
	GetRTExpiry() time.Time
}

type ITokenStore interface {
	StoreTokenProfile(ctx context.Context, reqId string, signatures ITokenSignatures, profile RequestProfile) (err error)
	GetProfileWithAuthCodeSign(ctx context.Context, signature string) (profile RequestProfile, reqId string, err error)
	GetProfileWithAccessTokenSign(ctx context.Context, signature string) (profile RequestProfile, reqId string, err error)
	GetProfileWithRefreshTokenSign(ctx context.Context, signature string) (profile RequestProfile, reqId string, err error)
	InvalidateWithRequestID(ctx context.Context, reqID string, what uint8) (err error)
}

type ITransactionManager interface {
	BeginTransaction(ctx context.Context, readOnly bool) context.Context
	CommitTransaction(ctx context.Context) context.Context
	RollbackTransaction(ctx context.Context) context.Context
}

type IUserInfoEPHandler interface {
	HandleUserInfoEP(ctx context.Context, requestContext IUserInfoRequestContext) IError
}

type IUserInfoRequestContext interface {
	GetBearerToken() string
	GetUsername() string
	SetUsername(username string)
	GetClaims() map[string]interface{}
	AddClaim(claimId string, value interface{})
	GetApprovedScopes() Arguments
	SetApprovedScopes(scopes Arguments)
	GetRequestedClaims() []string
	SetRequestedClaims(claimIds []string)
}

type IUserStore interface {
	Authenticate(ctx context.Context, username string, credential []byte) (err error)
	GetClaims(ctx context.Context, username string, scopes Arguments, claimsIDs []string) (map[string]interface{}, error)
	IsConsentRequired(ctx context.Context, username string, clientId string, scopes Arguments) bool
	StoreConsent(ctx context.Context, username string, clientId string, scopes Arguments) error
	FetchUserProfile(ctx context.Context, username string) RequestProfile
}

type RequestProfile map[string]string

type TokenSignatures struct {
	AuthorizationCodeSignature string
	AccessTokenSignature       string
	RefreshTokenSignature      string
	RefreshTokenExpiry         time.Time
	AccessTokenExpiry          time.Time
	AuthorizationCodeExpiry    time.Time
}

type Tokens struct {
	TokenSignatures
	AuthorizationCode string
	AccessToken       string
	RefreshToken      string
	TokenType         string
	IDToken           string
}