8d35e824ae
- Deleted obsolete test files for various OpenAPI components, including config_test.go, dsl_test.go, hello_test.go, oauth_test.go, oauth_token_test.go, and openapi_test.go, to streamline the codebase. - Refactored OAuth response handling by integrating response methods from the response package, ensuring consistent error and success responses across OAuth endpoints. - Enhanced error handling and response structure for improved clarity and maintainability, aligning with best practices for API responses.
259 lines
13 KiB
Go
259 lines
13 KiB
Go
package response
|
|
|
|
import (
|
|
"net/http"
|
|
|
|
"github.com/gin-gonic/gin"
|
|
"github.com/yaoapp/yao/openapi/oauth/types"
|
|
)
|
|
|
|
// Type aliases for OAuth types to simplify usage
|
|
type (
|
|
// Core response types
|
|
|
|
// ErrorResponse represents an OAuth 2.0 error response as defined in RFC 6749
|
|
ErrorResponse = types.ErrorResponse
|
|
|
|
// Token represents an OAuth 2.0 access token response as defined in RFC 6749
|
|
Token = types.Token
|
|
|
|
// RefreshTokenResponse represents an OAuth 2.0 refresh token response
|
|
RefreshTokenResponse = types.RefreshTokenResponse
|
|
|
|
// Authorization flow types
|
|
|
|
// AuthorizationRequest represents an OAuth 2.0 authorization request parameters
|
|
AuthorizationRequest = types.AuthorizationRequest
|
|
|
|
// AuthorizationResponse represents an OAuth 2.0 authorization response
|
|
AuthorizationResponse = types.AuthorizationResponse
|
|
|
|
// Client management types
|
|
|
|
// ClientInfo represents OAuth 2.0 client registration information
|
|
ClientInfo = types.ClientInfo
|
|
|
|
// DynamicClientRegistrationRequest represents a dynamic client registration request as defined in RFC 7591
|
|
DynamicClientRegistrationRequest = types.DynamicClientRegistrationRequest
|
|
|
|
// DynamicClientRegistrationResponse represents a dynamic client registration response as defined in RFC 7591
|
|
DynamicClientRegistrationResponse = types.DynamicClientRegistrationResponse
|
|
|
|
// Extended OAuth types
|
|
|
|
// DeviceAuthorizationResponse represents a device authorization response as defined in RFC 8628
|
|
DeviceAuthorizationResponse = types.DeviceAuthorizationResponse
|
|
|
|
// PushedAuthorizationRequest represents a pushed authorization request as defined in RFC 9126
|
|
PushedAuthorizationRequest = types.PushedAuthorizationRequest
|
|
|
|
// PushedAuthorizationResponse represents a pushed authorization response as defined in RFC 9126
|
|
PushedAuthorizationResponse = types.PushedAuthorizationResponse
|
|
|
|
// TokenExchangeResponse represents a token exchange response as defined in RFC 8693
|
|
TokenExchangeResponse = types.TokenExchangeResponse
|
|
|
|
// TokenIntrospectionResponse represents a token introspection response as defined in RFC 7662
|
|
TokenIntrospectionResponse = types.TokenIntrospectionResponse
|
|
|
|
// Discovery types
|
|
|
|
// AuthorizationServerMetadata represents OAuth 2.0 authorization server metadata as defined in RFC 8414
|
|
AuthorizationServerMetadata = types.AuthorizationServerMetadata
|
|
|
|
// ProtectedResourceMetadata represents OAuth 2.0 protected resource metadata as defined in RFC 9728
|
|
ProtectedResourceMetadata = types.ProtectedResourceMetadata
|
|
|
|
// Security types
|
|
|
|
// WWWAuthenticateChallenge represents a WWW-Authenticate challenge header structure
|
|
WWWAuthenticateChallenge = types.WWWAuthenticateChallenge
|
|
|
|
// JWKSResponse represents a JSON Web Key Set response as defined in RFC 7517
|
|
JWKSResponse = types.JWKSResponse
|
|
|
|
// JWK represents a JSON Web Key as defined in RFC 7517
|
|
JWK = types.JWK
|
|
)
|
|
|
|
// Standard OAuth 2.0/2.1 Error Codes - RFC 6749 Section 5.2
|
|
var (
|
|
// Authorization endpoint errors - RFC 6749 Section 4.1.2.1
|
|
ErrInvalidRequest = &ErrorResponse{Code: types.ErrorInvalidRequest, ErrorDescription: "The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed."}
|
|
ErrUnauthorizedClient = &ErrorResponse{Code: types.ErrorUnauthorizedClient, ErrorDescription: "The client is not authorized to request an authorization code using this method."}
|
|
ErrAccessDenied = &ErrorResponse{Code: types.ErrorAccessDenied, ErrorDescription: "The resource owner or authorization server denied the request."}
|
|
ErrUnsupportedResponseType = &ErrorResponse{Code: types.ErrorUnsupportedResponseType, ErrorDescription: "The authorization server does not support obtaining an authorization code using this method."}
|
|
ErrInvalidScope = &ErrorResponse{Code: types.ErrorInvalidScope, ErrorDescription: "The requested scope is invalid, unknown, or malformed."}
|
|
ErrServerError = &ErrorResponse{Code: types.ErrorServerError, ErrorDescription: "The authorization server encountered an unexpected condition that prevented it from fulfilling the request."}
|
|
ErrTemporarilyUnavailable = &ErrorResponse{Code: types.ErrorTemporarilyUnavailable, ErrorDescription: "The authorization server is currently unable to handle the request due to a temporary overloading or maintenance of the server."}
|
|
|
|
// Token endpoint errors - RFC 6749 Section 5.2
|
|
ErrInvalidClient = &ErrorResponse{Code: types.ErrorInvalidClient, ErrorDescription: "Client authentication failed (e.g., unknown client, no client authentication included, or unsupported authentication method)."}
|
|
ErrInvalidGrant = &ErrorResponse{Code: types.ErrorInvalidGrant, ErrorDescription: "The provided authorization grant (e.g., authorization code, resource owner credentials) or refresh token is invalid, expired, revoked, does not match the redirection URI used in the authorization request, or was issued to another client."}
|
|
ErrUnsupportedGrantType = &ErrorResponse{Code: types.ErrorUnsupportedGrantType, ErrorDescription: "The authorization grant type is not supported by the authorization server."}
|
|
|
|
// Token introspection and validation errors - RFC 7662
|
|
ErrInvalidToken = &ErrorResponse{Code: types.ErrorInvalidToken, ErrorDescription: "The access token provided is expired, revoked, malformed, or invalid for other reasons."}
|
|
ErrInsufficientScope = &ErrorResponse{Code: types.ErrorInsufficientScope, ErrorDescription: "The request requires higher privileges than provided by the access token."}
|
|
|
|
// Device authorization flow errors - RFC 8628 Section 3.5
|
|
ErrAuthorizationPending = &ErrorResponse{Code: types.ErrorAuthorizationPending, ErrorDescription: "The authorization request is still pending as the end user hasn't yet completed the user-interaction steps."}
|
|
ErrSlowDown = &ErrorResponse{Code: types.ErrorSlowDown, ErrorDescription: "The client should slow down the polling requests to the token endpoint."}
|
|
ErrExpiredToken = &ErrorResponse{Code: types.ErrorExpiredToken, ErrorDescription: "The device_code has expired, and the device authorization session has concluded."}
|
|
|
|
// Extended error codes for better developer experience
|
|
ErrMissingRedirectURI = &ErrorResponse{Code: "missing_redirect_uri", ErrorDescription: "The redirect_uri parameter is required but was not provided."}
|
|
ErrInvalidRedirectURI = &ErrorResponse{Code: "invalid_redirect_uri", ErrorDescription: "The redirect_uri parameter value is invalid or not registered for this client."}
|
|
ErrMismatchedRedirectURI = &ErrorResponse{Code: "mismatched_redirect_uri", ErrorDescription: "The redirect_uri does not match the one used in the authorization request."}
|
|
ErrInvalidCodeVerifier = &ErrorResponse{Code: "invalid_code_verifier", ErrorDescription: "The code_verifier does not match the code_challenge from the authorization request."}
|
|
ErrMissingCodeChallenge = &ErrorResponse{Code: "missing_code_challenge", ErrorDescription: "PKCE code_challenge is required but was not provided."}
|
|
ErrInvalidCodeChallenge = &ErrorResponse{Code: "invalid_code_challenge", ErrorDescription: "The code_challenge parameter is invalid or uses an unsupported method."}
|
|
ErrInvalidClientMetadata = &ErrorResponse{Code: "invalid_client_metadata", ErrorDescription: "The client metadata is invalid or contains unsupported values."}
|
|
ErrInvalidSoftwareStatement = &ErrorResponse{Code: "invalid_software_statement", ErrorDescription: "The software statement is invalid or cannot be verified."}
|
|
ErrUnapprovedSoftware = &ErrorResponse{Code: "unapproved_software", ErrorDescription: "The software statement represents software that has been replaced or is otherwise invalid."}
|
|
|
|
// Configuration and service errors
|
|
ErrInvalidConfiguration = types.ErrInvalidConfiguration
|
|
ErrStoreMissing = types.ErrStoreMissing
|
|
ErrIssuerURLMissing = types.ErrIssuerURLMissing
|
|
ErrCertificateMissing = types.ErrCertificateMissing
|
|
ErrInvalidTokenLifetime = types.ErrInvalidTokenLifetime
|
|
ErrPKCEConfigurationInvalid = types.ErrPKCEConfigurationInvalid
|
|
)
|
|
|
|
// Standard HTTP Status Codes for OAuth Responses
|
|
const (
|
|
// Success responses
|
|
StatusOK = http.StatusOK // 200 - Successful token response
|
|
StatusCreated = http.StatusCreated // 201 - Successful client registration
|
|
StatusNoContent = http.StatusNoContent // 204 - Successful token revocation
|
|
|
|
// Client error responses
|
|
StatusBadRequest = http.StatusBadRequest // 400 - Invalid request parameters
|
|
StatusUnauthorized = http.StatusUnauthorized // 401 - Authentication required
|
|
StatusForbidden = http.StatusForbidden // 403 - Access denied
|
|
StatusNotFound = http.StatusNotFound // 404 - Client or resource not found
|
|
StatusMethodNotAllowed = http.StatusMethodNotAllowed // 405 - HTTP method not supported
|
|
StatusNotAcceptable = http.StatusNotAcceptable // 406 - Content type not acceptable
|
|
StatusConflict = http.StatusConflict // 409 - Client already exists
|
|
StatusUnprocessableEntity = http.StatusUnprocessableEntity // 422 - Invalid client metadata
|
|
|
|
// Server error responses
|
|
StatusInternalServerError = http.StatusInternalServerError // 500 - Internal server error
|
|
StatusNotImplemented = http.StatusNotImplemented // 501 - Feature not implemented
|
|
StatusBadGateway = http.StatusBadGateway // 502 - Bad gateway
|
|
StatusServiceUnavailable = http.StatusServiceUnavailable // 503 - Service temporarily unavailable
|
|
)
|
|
|
|
// setOAuthSecurityHeaders sets standard OAuth 2.0/2.1 security headers
|
|
// These headers are required by OAuth 2.1 specification for enhanced security
|
|
func SetOAuthSecurityHeaders(c *gin.Context) {
|
|
c.Header("Cache-Control", "no-store")
|
|
c.Header("Pragma", "no-cache")
|
|
c.Header("X-Content-Type-Options", "nosniff")
|
|
c.Header("X-Frame-Options", "DENY")
|
|
c.Header("Referrer-Policy", "no-referrer")
|
|
}
|
|
|
|
// setJSONContentType sets JSON content type header for OAuth responses
|
|
func SetJSONContentType(c *gin.Context) {
|
|
c.Header("Content-Type", "application/json")
|
|
}
|
|
|
|
// RespondWithSuccess sends a successful response (no wrapper, direct data)
|
|
func RespondWithSuccess(c *gin.Context, statusCode int, data interface{}) {
|
|
SetJSONContentType(c)
|
|
c.JSON(statusCode, data)
|
|
}
|
|
|
|
// RespondWithError sends an error response (no wrapper, direct error)
|
|
func RespondWithError(c *gin.Context, statusCode int, err *ErrorResponse) {
|
|
SetJSONContentType(c)
|
|
|
|
// Add WWW-Authenticate header for 401 responses
|
|
if statusCode == StatusUnauthorized {
|
|
AddWWWAuthenticateHeader(c, err)
|
|
}
|
|
|
|
c.JSON(statusCode, err)
|
|
}
|
|
|
|
// RespondWithAuthorizationError sends an authorization endpoint error via redirect
|
|
func RespondWithAuthorizationError(c *gin.Context, redirectURI string, err *ErrorResponse, state string) {
|
|
// Build error redirect URL
|
|
redirectURL := redirectURI
|
|
if redirectURL != "" {
|
|
separator := "?"
|
|
if len(redirectURL) > 0 && redirectURL[len(redirectURL)-1:] == "?" {
|
|
separator = "&"
|
|
}
|
|
|
|
redirectURL += separator + "error=" + err.Code
|
|
if err.ErrorDescription != "" {
|
|
redirectURL += "&error_description=" + err.ErrorDescription
|
|
}
|
|
if err.ErrorURI != "" {
|
|
redirectURL += "&error_uri=" + err.ErrorURI
|
|
}
|
|
if state != "" {
|
|
redirectURL += "&state=" + state
|
|
}
|
|
|
|
c.Redirect(http.StatusFound, redirectURL)
|
|
return
|
|
}
|
|
|
|
// Fallback to JSON error response if no redirect URI
|
|
RespondWithError(c, StatusBadRequest, err)
|
|
}
|
|
|
|
// AddWWWAuthenticateHeader adds appropriate WWW-Authenticate header
|
|
func AddWWWAuthenticateHeader(c *gin.Context, err *ErrorResponse) {
|
|
challenge := &WWWAuthenticateChallenge{
|
|
Scheme: types.WWWAuthenticateSchemeBearer,
|
|
Realm: "OAuth",
|
|
}
|
|
|
|
if err != nil {
|
|
challenge.Error = err.Code
|
|
challenge.ErrorDesc = err.ErrorDescription
|
|
challenge.ErrorURI = err.ErrorURI
|
|
}
|
|
|
|
// Build WWW-Authenticate header value
|
|
headerValue := challenge.Scheme
|
|
if challenge.Realm != "" {
|
|
headerValue += ` realm="` + challenge.Realm + `"`
|
|
}
|
|
if challenge.Error != "" {
|
|
headerValue += `, error="` + challenge.Error + `"`
|
|
}
|
|
if challenge.ErrorDesc != "" {
|
|
headerValue += `, error_description="` + challenge.ErrorDesc + `"`
|
|
}
|
|
if challenge.ErrorURI != "" {
|
|
headerValue += `, error_uri="` + challenge.ErrorURI + `"`
|
|
}
|
|
|
|
c.Header("WWW-Authenticate", headerValue)
|
|
}
|
|
|
|
// RespondWithSecureSuccess sends a successful response with OAuth security headers (for sensitive endpoints)
|
|
func RespondWithSecureSuccess(c *gin.Context, statusCode int, data interface{}) {
|
|
SetOAuthSecurityHeaders(c)
|
|
SetJSONContentType(c)
|
|
c.JSON(statusCode, data)
|
|
}
|
|
|
|
// RespondWithSecureError sends an error response with OAuth security headers (for sensitive endpoints)
|
|
func RespondWithSecureError(c *gin.Context, statusCode int, err *ErrorResponse) {
|
|
SetOAuthSecurityHeaders(c)
|
|
SetJSONContentType(c)
|
|
|
|
// Add WWW-Authenticate header for 401 responses
|
|
if statusCode == StatusUnauthorized {
|
|
AddWWWAuthenticateHeader(c, err)
|
|
}
|
|
|
|
c.JSON(statusCode, err)
|
|
}
|