mirror of
https://github.com/hanzoai/ca.git
synced 2026-11-03 18:08:27 +00:00
* Fix issues F-003, 006, 001, 022
* Fix issues F-025, 026, 010, 008
- Login tokens name their identity provider in the `provider` claim;
SelectOrg and GetUserToken read it with pb.IDPFromString, which also
takes the number older tokens carry, and AuthenticateAPIKey answers
Provider Undefined.
- A login that fails after the callback decodes its state lands on the
redirect URI of the client, in its response mode, with `error` and
`error_description` (RFC 6749 section 4.1.2.1); a server-side failure
is described by its status text only. The calls to an IdP take the
request context and a client with a timeout, and the answer of the IdP
stays in the server log.
- The platform bootstrap reads its ca-config with ca.LoadBootstrapConfig,
which refuses an issuer URL template with `${ISSUER_ID}` or
`$ISSUER_ID`: the loader expands them to an empty string. The proto,
README and CLI help name `:ISSUER_ID`.
- CaDb.RegisterIssuer takes the trust anchor of a root issuer and writes
both in one transaction; the backend service and the bootstrap pass it,
and an anchor registered in another scope is AlreadyExists.
Co-Authored-By: Claude Opus 5.5 <[email protected]>
* Address PR review comments
- Invite acceptance deletes the invite in its transaction
(query.TakeInvite, DELETE ... RETURNING) and grants from the deleted
row: a withdrawn or already accepted invite grants nothing, a re-issued
one grants its current role, and an email mismatch, an expired invite or
a failed grant rolls the delete back.
- CaDb.RegisterIssuer requires the anchor of a root issuer and refuses one
for any other issuer; the service always builds it for a root.
- The OAuth response is merged into the query of a redirect URI that has
one, and replaces its fragment in fragment mode.
- The codemap describes the transactions of RegisterOrg and the invite
acceptance.
Co-Authored-By: Claude Opus 5.5 <[email protected]>
---------
Co-authored-by: Claude Opus 5.5 <[email protected]>
204 lines
6.2 KiB
Go
204 lines
6.2 KiB
Go
package pb
|
|
|
|
// Status service API
|
|
const (
|
|
// PathForStatus is base path for the Status service
|
|
PathForStatus = "/v1/status"
|
|
|
|
// PathForStatusVersion returns ServerVersion,
|
|
// that proviodes the version of the installed package.
|
|
//
|
|
// Verbs: GET
|
|
// Response: v1.ServerVersion
|
|
PathForStatusVersion = "/v1/status/version"
|
|
|
|
// PathForStatusServer returns ServerStatusResponse.
|
|
//
|
|
// Verbs: GET
|
|
// Response: v1.ServerStatusResponse
|
|
PathForStatusServer = "/v1/status/server"
|
|
|
|
// PathForStatusNode returns `ALIVE` if the server is ready to server,
|
|
// or 503 Service Unavailable otherwise.
|
|
// This end-point can be used with Load Balancers
|
|
//
|
|
// Verbs: GET
|
|
// Response: string
|
|
// Content-Type: text/plain
|
|
PathForStatusNode = "/v1/status/node"
|
|
|
|
// PathForSwagger returns swagger file.
|
|
//
|
|
// Verbs: GET
|
|
// Response: JSON
|
|
PathForSwagger = "/v1/swagger/:service"
|
|
)
|
|
|
|
// Auth service API
|
|
const (
|
|
// PathForAuth provides the base path for auth service
|
|
PathForAuth = "/pb.Auth/:actions"
|
|
|
|
// PathForAuthProviders provides list of supported providers
|
|
PathForAuthProviders = "/v1/auth/providers"
|
|
|
|
// PathForAuthCallback is auth callback for OAuth flow
|
|
PathForAuthCallback = "/v1/auth/callback"
|
|
|
|
// PathForAuthorize starts authorization flow
|
|
//
|
|
// Verbs: GET
|
|
// Response: 303
|
|
PathForAuthorize = "/v1/auth/authorize"
|
|
|
|
// PathForAuthOrg selects the org of the session, as Auth.SelectOrg does,
|
|
// and writes the new token into the auth cookie of a cookie session
|
|
//
|
|
// Verbs: POST
|
|
// Request: SelectOrgRequest
|
|
// Response: UserTokenResponse
|
|
PathForAuthOrg = "/v1/auth/org"
|
|
|
|
// PathForAuthUserinfo returns UserInfo for the caller
|
|
// Verbs: GET
|
|
// Response: JWT token or JSON encoded claims
|
|
PathForAuthUserinfo = "/v1/auth/userinfo"
|
|
|
|
// PathForAuthUserToken returns Token and UserInfo
|
|
// Verbs: GET
|
|
// Response: UserTokenResponse
|
|
PathForAuthUserToken = "/v1/auth/usertoken"
|
|
|
|
// PathForStatusCaller returns CallerStatusResponse.
|
|
//
|
|
// Verbs: GET
|
|
// Response: v1.CallerStatusResponse
|
|
PathForStatusCaller = "/v1/auth/caller"
|
|
|
|
// PathForRemoveCookie returns NoContent status.
|
|
//
|
|
// Verbs: DELETE
|
|
// Response: 204
|
|
PathForRemoveCookie = "/v1/auth/removecookie"
|
|
)
|
|
|
|
// CIS service API: the JSON API of the Certificate Information Service,
|
|
// served by the wfe listener to authenticated callers
|
|
const (
|
|
// PathForCIS provides the base path of the JSON API of the CIS service
|
|
//
|
|
// Verbs: POST
|
|
PathForCIS = "/pb.CIS/:action"
|
|
)
|
|
|
|
// AIA service API: the binary endpoints the issued certificates reference
|
|
// (the AIA and CDP extensions), served by the aia service over plain HTTP
|
|
// to any caller:
|
|
//
|
|
// GET /v1/cert/{ikid} application/pkix-cert issuer certificate
|
|
// GET /v1/crl/{ikid} application/pkix-crl current CRL (DER)
|
|
// GET /v1/ocspi/{ikid}/{req} application/ocsp-response (request in the path)
|
|
// POST /v1/ocspi/{ikid} application/ocsp-response (issuer by KID)
|
|
// POST /v1/ocsp application/ocsp-response
|
|
// GET /v1/ocsp/{req} application/ocsp-response (request body in GET)
|
|
//
|
|
// The issuer and CRL paths are the AIA and CDP templates of the issuers
|
|
// (`issuer_url`, `crl_url`): a renamed path leaves the URLs embedded in the
|
|
// issued certificates without a route.
|
|
const (
|
|
// PathForCert provides the issuer certificate by IKID
|
|
//
|
|
// Verbs: GET
|
|
// Content-Type: application/pkix-cert
|
|
// Response: CertificateResponse
|
|
PathForCert = "/v1/cert/:ikid"
|
|
// PathForCRL provides the current CRL by IKID
|
|
//
|
|
// Verbs: GET
|
|
// Content-Type: application/pkix-crl
|
|
// Response: CrlResponse
|
|
PathForCRL = "/v1/crl/:ikid"
|
|
|
|
// PathForOCSP provides the OCSP response by issuer KID
|
|
//
|
|
// Verbs: POST
|
|
// Content-Type: application/ocsp-response
|
|
// Response: OCSPResponse
|
|
PathForOCSP = "/v1/ocsp"
|
|
|
|
// PathForGetOCSPByBody provides the OCSP response by the request body in
|
|
// GET (RFC 6960 A.1): the URL-encoded base64 of the DER request, which
|
|
// contains '/' and '+'. Go decodes the path before routing, so the body
|
|
// is a catch-all segment, with a leading slash the handler strips.
|
|
//
|
|
// Verbs: GET
|
|
// Content-Type: application/ocsp-response
|
|
// Response: OCSPResponse
|
|
PathForGetOCSPByBody = "/v1/ocsp/*body"
|
|
|
|
// PathForGetOCSP provides the OCSP response by IKID and request: the
|
|
// URL-encoded base64 of the DER request is a catch-all segment, as in
|
|
// PathForGetOCSPByBody
|
|
//
|
|
// Verbs: GET
|
|
// Content-Type: application/ocsp-response
|
|
// Response: OCSPResponse
|
|
PathForGetOCSP = "/v1/ocspi/:ikid/*body"
|
|
// PathForOCSPByIssuerID provides the OCSP response by IKID
|
|
//
|
|
// Verbs: POST
|
|
// Content-Type: application/ocsp-response
|
|
// Response: OCSPResponse
|
|
PathForOCSPByIssuerID = "/v1/ocspi/:ikid"
|
|
)
|
|
|
|
// Webhooks
|
|
const (
|
|
// PathForWebhooks provides the base path for webhooks
|
|
PathForWebhooks = "/v1/webhooks/:actions"
|
|
)
|
|
|
|
// List of supported Types
|
|
const (
|
|
OAuthResponseTypeIDToken = "id_token"
|
|
OAuthResponseTypeCode = "code"
|
|
OAuthResponseTypeToken = "token"
|
|
OAuthResponseTypeCookie = "cookie"
|
|
)
|
|
|
|
// The error of a failed authorization (RFC 6749 section 4.1.2.1): the
|
|
// callback answers a login that fails after its state is decoded on the
|
|
// redirect URI of the client, with the code in OAuthParamError and the
|
|
// reason in OAuthParamErrorDescription; an IdP answers the callback the
|
|
// same way.
|
|
const (
|
|
OAuthParamError = "error"
|
|
OAuthParamErrorDescription = "error_description"
|
|
|
|
OAuthErrorInvalidRequest = "invalid_request"
|
|
OAuthErrorUnauthorizedClient = "unauthorized_client"
|
|
OAuthErrorAccessDenied = "access_denied"
|
|
OAuthErrorUnsupportedResponseType = "unsupported_response_type"
|
|
OAuthErrorInvalidScope = "invalid_scope"
|
|
OAuthErrorServerError = "server_error"
|
|
OAuthErrorTemporarilyUnavailable = "temporarily_unavailable"
|
|
)
|
|
|
|
// Web pages served by the ui service.
|
|
// These are plain HTML test pages, not API end-points.
|
|
const (
|
|
// PathForLoginPage renders the login page that lists the ID providers
|
|
// and starts the OAuth flow via PathForAuthorize.
|
|
//
|
|
// Verbs: GET
|
|
// Response: text/html
|
|
PathForLoginPage = "/login"
|
|
|
|
// PathForAuthenticatedPage is the default redirect target
|
|
// after a successful login from PathForLoginPage.
|
|
//
|
|
// Verbs: GET
|
|
// Response: text/html
|
|
PathForAuthenticatedPage = "/authenticated"
|
|
)
|