17800152848

Committed 17 Sep 2025 02:01PM UTC coverage: 44.17% (-0.1%) from 44.317%

Build # 17800152848

Build Type

push

github

Committed by

web-flow

Commit Message

Merge pull request #66 from FIWARE/dcql

Support DCQL

Run Details

24 of 60 new or added lines in 4 files covered. (40.0%)

1 existing line in 1 file now uncovered.

1485 of 3362 relevant lines covered (44.17%)

0.5 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

58.67

/openapi/api_api.go

/*
 * vcverifier
 *
 * Backend component to verify credentials
 *
 * API version: 0.0.1
 * Generated by: OpenAPI Generator (https://openapi-generator.tech)
 */

package openapi

import (
        "encoding/base64"
        "encoding/json"
        "errors"
        "fmt"
        "net/http"
        "slices"
        "strings"

        "github.com/fiware/VCVerifier/common"
        "github.com/fiware/VCVerifier/logging"
        "github.com/fiware/VCVerifier/verifier"
        "github.com/lestrrat-go/jwx/v3/jwa"
        "github.com/lestrrat-go/jwx/v3/jwt"
        vdr_jwk "github.com/trustbloc/did-go/method/jwk"
        vdr_key "github.com/trustbloc/did-go/method/key"
        vdr_web "github.com/trustbloc/did-go/method/web"
        "github.com/trustbloc/did-go/vdr/api"
        "github.com/trustbloc/vc-go/verifiable"

        "github.com/gin-gonic/gin"
)

var apiVerifier verifier.Verifier
var presentationParser verifier.PresentationParser
var sdJwtParser verifier.SdJwtParser
var keyResolver verifier.KeyResolver

var ErrorMessagNoGrantType = ErrorMessage{"no_grant_type_provided", "Token requests require a grant_type."}
var ErrorMessageUnsupportedGrantType = ErrorMessage{"unsupported_grant_type", "Provided grant_type is not supported by the implementation."}
var ErrorMessageNoCode = ErrorMessage{"no_code_provided", "Token requests require a code."}
var ErrorMessageNoRedircetUri = ErrorMessage{"no_redirect_uri_provided", "Token requests require a redirect_uri."}
var ErrorMessageNoState = ErrorMessage{"no_state_provided", "Authentication requires a state provided as query parameter."}
var ErrorMessageNoScope = ErrorMessage{"no_scope_provided", "Authentication requires a scope provided as a parameter."}
var ErrorMessageNoNonce = ErrorMessage{"no_nonce_provided", "Authentication requires a nonce provided as a query parameter."}
var ErrorMessageNoToken = ErrorMessage{"no_token_provided", "Authentication requires a token provided as a form parameter."}
var ErrorMessageNoPresentationSubmission = ErrorMessage{"no_presentation_submission_provided", "Authentication requires a presentation submission provided as a form parameter."}
var ErrorMessageNoCallback = ErrorMessage{"NoCallbackProvided", "A callback address has to be provided as query-parameter."}
var ErrorMessageUnableToDecodeToken = ErrorMessage{"invalid_token", "Token could not be decoded."}
var ErrorMessageUnableToDecodeCredential = ErrorMessage{"invalid_token", "Could not read the credential(s) inside the token."}
var ErrorMessageUnableToDecodeHolder = ErrorMessage{"invalid_token", "Could not read the holder inside the token."}
var ErrorMessageNoSuchSession = ErrorMessage{"no_session", "Session with the requested id is not available."}
var ErrorMessageInvalidSdJwt = ErrorMessage{"invalid_sdjwt", "SdJwt does not contain all required fields."}
var ErrorMessageNoWebsocketConnection = ErrorMessage{"invalid_connection", "No Websocket connection available for the authenticated session."}
var ErrorMessageUnresolvableRequestObject = ErrorMessage{"unresolvable_request_object", "Was not able to get the request object from the client."}
var ErrorMessageInvalidAudience = ErrorMessage{"invalid_audience", "Audience of the request object was invalid."}
var ErrorMessageUnsupportedAssertionType = ErrorMessage{"unsupported_assertion_type", "Assertion type is not supported."}
var ErrorMessageInvalidClientAssertion = ErrorMessage{"invalid_client_assertion", "Provided client assertion is invalid."}
var ErrorMessageInvalidTokenRequest = ErrorMessage{"invalid_token_request", "Token request has no redirect_uri and no valid client assertion."}

func getApiVerifier() verifier.Verifier {
        if apiVerifier == nil {
                apiVerifier = verifier.GetVerifier()
        }
        return apiVerifier
}

func getPresentationParser() verifier.PresentationParser {
        if presentationParser == nil {
                presentationParser = verifier.GetPresentationParser()
        }
        return presentationParser
}

func getSdJwtParser() verifier.SdJwtParser {
        if sdJwtParser == nil {
                sdJwtParser = verifier.GetSdJwtParser()
        }
        return sdJwtParser
}

func getKeyResolver() verifier.KeyResolver {
        if keyResolver == nil {
                keyResolver = &verifier.VdrKeyResolver{Vdr: []api.VDR{vdr_key.New(), vdr_jwk.New(), vdr_web.New()}}
        }
        return keyResolver
}

// GetToken - Token endpoint to exchange the authorization code with the actual JWT.
func GetToken(c *gin.Context) {

        logging.Log().Debugf("%v", c.Request)
        grantType, grantTypeExists := c.GetPostForm("grant_type")
        if !grantTypeExists {
                logging.Log().Debug("No grant_type present in the request.")
                c.AbortWithStatusJSON(400, ErrorMessagNoGrantType)
                return
        }

        if grantType == common.TYPE_CODE {
                handleTokenTypeCode(c)
        } else if grantType == common.TYPE_VP_TOKEN {
                handleTokenTypeVPToken(c, c.GetHeader("client_id"))
        } else {
                c.AbortWithStatusJSON(400, ErrorMessageUnsupportedGrantType)
        }
}

// GetToken - Token endpoint to exchange the authorization code with the actual JWT.
func GetTokenForService(c *gin.Context) {

        logging.Log().Debugf("%v", c.Request)
        grantType, grantTypeExists := c.GetPostForm("grant_type")
        if !grantTypeExists {
                logging.Log().Debug("No grant_type present in the request.")
                c.AbortWithStatusJSON(400, ErrorMessagNoGrantType)
                return
        }

        if grantType == common.TYPE_CODE {
                handleTokenTypeCode(c)
        } else if grantType == common.TYPE_VP_TOKEN {
                handleTokenTypeVPToken(c, c.Param("service_id"))
        } else {
                c.AbortWithStatusJSON(400, ErrorMessageUnsupportedGrantType)
        }
}

func handleTokenTypeVPToken(c *gin.Context, clientId string) {
        var requestBody TokenRequestBody

        vpToken, vpTokenExists := c.GetPostForm("vp_token")
        if !vpTokenExists {
                logging.Log().Debug("No vp token present in the request.")
                c.AbortWithStatusJSON(400, ErrorMessageNoToken)
                return
        }

        logging.Log().Warnf("Got token %s", vpToken)

        // not used at the moment
        // presentationSubmission, presentationSubmissionExists := c.GetPostForm("presentation_submission")
        // if !presentationSubmissionExists {
        //        logging.Log().Debug("No presentation submission present in the request.")
        //        c.AbortWithStatusJSON(400, ErrorMessageNoPresentationSubmission)
        //        return
        //}

        scope, scopeExists := c.GetPostForm("scope")
        if !scopeExists {
                logging.Log().Debug("No scope present in the request.")
                c.AbortWithStatusJSON(400, ErrorMessageNoScope)
                return
        }

        presentation, err := extractVpFromToken(c, vpToken)
        if err != nil {
                logging.Log().Warnf("Was not able to extract the credentials from the vp_token. E: %v", err)
                return
        }

        scopes := strings.Split(scope, ",")

        // Subject is empty since multiple VCs with different subjects can be provided
        expiration, signedToken, err := getApiVerifier().GenerateToken(clientId, "", clientId, scopes, presentation)
        if err != nil {
                logging.Log().Error("Failure during generating M2M token: ", err)
                c.AbortWithStatusJSON(400, err)
                return
        }
        response := TokenResponse{"Bearer", float32(expiration), signedToken, requestBody.Scope, ""}
        logging.Log().Infof("Generated and signed token: %v", response)
        c.JSON(http.StatusOK, response)
}

func handleTokenTypeCode(c *gin.Context) {

        code, codeExists := c.GetPostForm("code")
        if !codeExists {
                logging.Log().Debug("No code present in the request.")
                c.AbortWithStatusJSON(400, ErrorMessageNoCode)
                return
        }

        assertionType, assertionTypeExists := c.GetPostForm("client_assertion_type")
        redirectUri, redirectUriExists := c.GetPostForm("redirect_uri")
        if redirectUriExists {
                jwt, expiration, err := getApiVerifier().GetToken(code, redirectUri, false)
                if err != nil {
                        c.AbortWithStatusJSON(403, ErrorMessage{Summary: err.Error()})
                        return
                }
                c.JSON(http.StatusOK, TokenResponse{TokenType: "Bearer", ExpiresIn: float32(expiration), AccessToken: jwt})
                return
        }
        if assertionTypeExists {
                handleWithClientAssertion(c, assertionType, code)
                return
        }
        c.AbortWithStatusJSON(400, ErrorMessageInvalidTokenRequest)
}

func handleWithClientAssertion(c *gin.Context, assertionType string, code string) {
        if assertionType != "urn:ietf:params:oauth:client-assertion-type:jwt-bearer" {
                logging.Log().Warnf("Assertion type %s is not supported.", assertionType)
                c.AbortWithStatusJSON(400, ErrorMessageUnsupportedAssertionType)
                return
        }

        clientAssertion, clientAssertionExists := c.GetPostForm("client_assertion")
        clientId, clientIdExists := c.GetPostForm("client_id")
        if !clientAssertionExists || !clientIdExists {
                logging.Log().Warnf("Client Id (%s) or assertion (%s) not provided.", clientId, clientAssertion)
                c.AbortWithStatusJSON(400, ErrorMessageUnsupportedAssertionType)
                return
        }

        kid, err := getKeyResolver().ExtractKIDFromJWT(clientAssertion)
        if err != nil {
                logging.Log().Warnf("Was not able to retrive kid from token %s. Err: %v.", clientAssertion, err)
                c.AbortWithStatusJSON(400, ErrorMessageInvalidClientAssertion)
                return
        }
        pubKey, err := getKeyResolver().ResolvePublicKeyFromDID(kid)
        if err != nil {
                logging.Log().Warnf("Was not able to retrive key from kid %s. Err: %v.", kid, err)
                c.AbortWithStatusJSON(400, ErrorMessageInvalidClientAssertion)
                return
        }

        alg, algExists := pubKey.Algorithm()
        if !algExists {
                // fallback to default
                alg = jwa.ES256()
        }

        parsed, err := jwt.Parse([]byte(clientAssertion), jwt.WithKey(alg, pubKey))
        if err != nil {
                logging.Log().Warnf("Was not able to parse and verify the token %s. Err: %v", clientAssertion, err)
                c.AbortWithStatusJSON(400, ErrorMessageInvalidClientAssertion)
                return
        }

        // Serialize token to JSON
        jsonBytes, err := json.Marshal(parsed)
        if err != nil {
                logging.Log().Warnf("Was not able to marshal the token %s. Err: %v", clientAssertion, err)
                c.AbortWithStatusJSON(400, ErrorMessageInvalidClientAssertion)
                return
        }

        // Unmarshal to your struct
        var clientAssertionObject ClientAssertion
        if err := json.Unmarshal(jsonBytes, &clientAssertionObject); err != nil {
                logging.Log().Warnf("Was not able to unmarshal the token: %s, Err: %v", string(jsonBytes), err)
                c.AbortWithStatusJSON(400, ErrorMessageInvalidClientAssertion)
                return
        }

        if clientAssertionObject.Sub != clientId || clientAssertionObject.Iss != clientId || !slices.Contains(clientAssertionObject.Aud, getFrontendVerifier().GetHost()) {
                logging.Log().Warnf("Invalid assertion: %s. Client Id: %s, Host: %s", logging.PrettyPrintObject(clientAssertionObject), clientId, getApiVerifier().GetHost())
                c.AbortWithStatusJSON(400, ErrorMessageInvalidClientAssertion)
                return
        }

        jwt, expiration, err := getApiVerifier().GetToken(code, "", true)
        if err != nil {
                c.AbortWithStatusJSON(403, ErrorMessage{Summary: err.Error()})
                return
        }
        c.JSON(http.StatusOK, TokenResponse{TokenType: "Bearer", ExpiresIn: float32(expiration), AccessToken: jwt})
}

// StartSIOPSameDevice - Starts the siop flow for credentials hold by the same device
func StartSIOPSameDevice(c *gin.Context) {
        state, stateExists := c.GetQuery("state")
        if !stateExists {
                logging.Log().Debugf("No state was provided.")
                c.AbortWithStatusJSON(400, ErrorMessage{"no_state_provided", "Authentication requires a state provided as query parameter."})
                return
        }
        redirectPath, redirectPathExists := c.GetQuery("redirect_path")
        if !redirectPathExists {
                redirectPath = "/"
        }

        protocol := "https"
        if c.Request.TLS == nil {
                protocol = "http"
        }

        clientId, clientIdExists := c.GetQuery("client_id")
        logging.Log().Debugf("The client id %s", clientId)
        if !clientIdExists {
                logging.Log().Infof("Start a login flow for a not specified client.")
        }

        requestMode, requestModeExists := c.GetQuery("request_mode")
        if !requestModeExists {
                logging.Log().Infof("Using default request mode %s.", DEFAULT_REQUEST_MODE)
                requestMode = DEFAULT_REQUEST_MODE
        }

        redirect, err := getApiVerifier().StartSameDeviceFlow(c.Request.Host, protocol, state, redirectPath, clientId, requestMode)
        if err != nil {
                logging.Log().Warnf("Error starting the same-device flow. Err: %v", err)
                c.AbortWithStatusJSON(500, ErrorMessage{err.Error(), "Was not able to start the same device flow."})
                return
        }
        c.Redirect(302, redirect)
}

// VerifierAPIAuthenticationResponse - Stores the credential for the given session
func VerifierAPIAuthenticationResponse(c *gin.Context) {

        var state string
        stateForm, stateFormExists := c.GetPostForm("state")
        stateQuery, stateQueryExists := c.GetQuery("state")
        if !stateFormExists && !stateQueryExists {
                c.AbortWithStatusJSON(400, ErrorMessageNoState)
                return
        }
        if stateFormExists {
                state = stateForm
        } else {
                // allow the state submitted through a query parameter for backwards-compatibility
                state = stateQuery
        }

        vptoken, tokenExists := c.GetPostForm("vp_token")
        if !tokenExists {
                logging.Log().Info("No token was provided.")
                c.AbortWithStatusJSON(400, ErrorMessageNoToken)
                return
        }

        presentation, err := extractVpFromToken(c, vptoken)
        if err != nil {
                logging.Log().Warnf("Was not able to extract the presentation from the vp_token.")
                return
        }
        handleAuthenticationResponse(c, state, presentation)
}

// GetVerifierAPIAuthenticationResponse - Stores the credential for the given session
func GetVerifierAPIAuthenticationResponse(c *gin.Context) {
        state, stateExists := c.GetQuery("state")
        if !stateExists {
                c.AbortWithStatusJSON(400, ErrorMessageNoState)
                return
        }

        vpToken, tokenExists := c.GetQuery("vp_token")
        if !tokenExists {
                logging.Log().Info("No token was provided.")
                c.AbortWithStatusJSON(400, ErrorMessageNoToken)
                return
        }
        presentation, err := extractVpFromToken(c, vpToken)
        if err != nil {
                logging.Log().Warnf("Was not able to extract the presentation from the vp_token.")
                return
        }
        handleAuthenticationResponse(c, state, presentation)
}

// GetRequestByReference - Get the request object by reference
func GetRequestByReference(c *gin.Context) {
        sessionId := c.Param("id")

        jwt, err := verifier.GetVerifier().GetRequestObject(sessionId)
        if err != nil {
                logging.Log().Debugf("No request for  %s. Err: %v", sessionId, err)
                c.AbortWithStatusJSON(404, ErrorMessageNoSuchSession)
                return
        }
        c.String(http.StatusOK, jwt)
}

func extractVpFromToken(c *gin.Context, vpToken string) (parsedPresentation *verifiable.Presentation, err error) {

        logging.Log().Debugf("The token %s.", vpToken)

        parsedPresentation, err = getPresentationFromQuery(c, vpToken)

        if err != nil {
                logging.Log().Debugf("Received a vpToken with a query, but was not able to extract the presentation. Token: %s", vpToken)
                return parsedPresentation, err
        }
        if parsedPresentation != nil {
                return parsedPresentation, err
        }
        return tokenToPresentation(c, vpToken)

}

func tokenToPresentation(c *gin.Context, vpToken string) (parsedPresentation *verifiable.Presentation, err error) {
        tokenBytes := decodeVpString(vpToken)

        isSdJWT, parsedPresentation, err := isSdJWT(c, vpToken)
        if isSdJWT && err != nil {
                return
        }
        if isSdJWT {
                logging.Log().Debugf("Received an sdJwt: %s", logging.PrettyPrintObject(parsedPresentation))
                return
        }

        parsedPresentation, err = getPresentationParser().ParsePresentation(tokenBytes)

        if err != nil {
                logging.Log().Infof("Was not able to parse the token %s. Err: %v", vpToken, err)
                c.AbortWithStatusJSON(400, ErrorMessageUnableToDecodeToken)
                return
        }
        return
}

func getPresentationFromQuery(c *gin.Context, vpToken string) (parsedPresentation *verifiable.Presentation, err error) {
        tokenBytes := decodeVpString(vpToken)

        var queryMap map[string]string
        //unmarshal
        err = json.Unmarshal(tokenBytes, &queryMap)
        if err != nil {
                logging.Log().Debug("VP Token does not contain query map. Checking the other options.", err)
                return nil, nil
        }

        for _, v := range queryMap {
                p, err := tokenToPresentation(c, v)
                if err != nil {
                        return nil, err
                }
                if parsedPresentation == nil {
                        parsedPresentation = p
                } else {
                        parsedPresentation.AddCredentials(p.Credentials()...)
                }
        }
        return parsedPresentation, err
}

// checks if the presented token contains a single sd-jwt credential. Will be repackage to a presentation for further validation
func isSdJWT(c *gin.Context, vpToken string) (isSdJwt bool, presentation *verifiable.Presentation, err error) {
        claims, err := getSdJwtParser().Parse(vpToken)
        if err != nil {
                logging.Log().Debugf("Was not a sdjwt. Err: %v", err)
                return false, presentation, err
        }
        issuer, i_ok := claims["iss"]
        vct, vct_ok := claims["vct"]
        if !i_ok || !vct_ok {
                logging.Log().Infof("Token does not contain issuer(%v) or vct(%v).", i_ok, vct_ok)
                c.AbortWithStatusJSON(400, ErrorMessageInvalidSdJwt)
                return true, presentation, errors.New(ErrorMessageInvalidSdJwt.Summary)
        }
        customFields := verifiable.CustomFields{}
        for k, v := range claims {
                if k != "iss" && k != "vct" {
                        customFields[k] = v
                }
        }
        subject := verifiable.Subject{CustomFields: customFields}
        contents := verifiable.CredentialContents{Issuer: &verifiable.Issuer{ID: issuer.(string)}, Types: []string{vct.(string)}, Subject: []verifiable.Subject{subject}}
        credential, err := verifiable.CreateCredential(contents, verifiable.CustomFields{})
        if err != nil {
                logging.Log().Infof("Was not able to create credential from sdJwt. E: %v", err)
                c.AbortWithStatusJSON(400, ErrorMessageInvalidSdJwt)
                return true, presentation, err
        }
        presentation, err = verifiable.NewPresentation()
        if err != nil {
                logging.Log().Infof("Was not able to create credpresentation from sdJwt. E: %v", err)
                c.AbortWithStatusJSON(400, ErrorMessageInvalidSdJwt)
                return true, presentation, err
        }
        presentation.AddCredentials(credential)
        presentation.Holder = issuer.(string)
        return true, presentation, nil
}

// decodeVpString - In newer versions of OID4VP the token is not encoded as a whole but only its segments separately. This function covers the older and newer versions
func decodeVpString(vpToken string) (tokenBytes []byte) {
        tokenBytes, err := base64.RawURLEncoding.DecodeString(vpToken)
        if err != nil {
                return []byte(vpToken)
        }
        return tokenBytes
}

func handleAuthenticationResponse(c *gin.Context, state string, presentation *verifiable.Presentation) {

        response, err := getApiVerifier().AuthenticationResponse(state, presentation)
        if err != nil {
                logging.Log().Warnf("Was not able to fullfil the authentication response. Err: %v", err)
                c.AbortWithStatusJSON(400, ErrorMessage{Summary: err.Error()})
                return
        }
        if response != (verifier.Response{}) && response.FlowVersion == verifier.SAME_DEVICE {
                if response.Nonce != "" {
                        c.Redirect(302, fmt.Sprintf("%s?state=%s&code=%s&nonce=%s", response.RedirectTarget, response.SessionId, response.Code, response.Nonce))
                } else {
                        c.Redirect(302, fmt.Sprintf("%s?state=%s&code=%s", response.RedirectTarget, response.SessionId, response.Code))
                }
                return
        } else if response != (verifier.Response{}) && response.FlowVersion == verifier.CROSS_DEVICE_V2 {
                sendRedirect(c, response.SessionId, response.Code, response.RedirectTarget)
        }
        logging.Log().Debugf("Successfully authenticated %s.", state)
        c.JSON(http.StatusOK, gin.H{})
}

// VerifierAPIJWKS - Provides the public keys for the given verifier, to be used for verifing the JWTs
func VerifierAPIJWKS(c *gin.Context) {
        c.JSON(http.StatusOK, getApiVerifier().GetJWKS())
}

// VerifierAPIOpenID
func VerifierAPIOpenIDConfiguration(c *gin.Context) {

        metadata, err := getApiVerifier().GetOpenIDConfiguration(c.Param("service_id"))
        if err != nil {
                c.AbortWithStatusJSON(500, ErrorMessage{err.Error(), "Was not able to generate the OpenID metadata."})
                return
        }
        c.JSON(http.StatusOK, metadata)
}

// VerifierAPIStartSIOP - Initiates the siop flow and returns the 'openid://...' connection string
func VerifierAPIStartSIOP(c *gin.Context) {
        state, stateExists := c.GetQuery("state")
        if !stateExists {
                c.AbortWithStatusJSON(400, ErrorMessageNoState)
                // early exit
                return
        }

        callback, callbackExists := c.GetQuery("client_callback")
        if !callbackExists {
                c.AbortWithStatusJSON(400, ErrorMessageNoCallback)
                // early exit
                return
        }
        protocol := "https"
        if c.Request.TLS == nil {
                protocol = "http"
        }
        clientId, clientIdExists := c.GetQuery("client_id")
        if !clientIdExists {
                logging.Log().Infof("Start a login flow for a not specified client.")
        }

        requestMode, requestModeExists := c.GetQuery("request_mode")
        if !requestModeExists {
                logging.Log().Infof("Using default request mode %s.", DEFAULT_REQUEST_MODE)
                requestMode = DEFAULT_REQUEST_MODE
        }

        connectionString, err := getApiVerifier().StartSiopFlow(c.Request.Host, protocol, callback, state, clientId, "", requestMode)
        if err != nil {
                c.AbortWithStatusJSON(500, ErrorMessage{err.Error(), "Was not able to generate the connection string."})
                return
        }
        c.String(http.StatusOK, connectionString)
}

type ClientAssertion struct {
        Iss string   `json:"iss"`
        Aud []string `json:"aud"`
        Sub string   `json:"sub"`
        Exp int      `json:"exp"`
        Iat int      `json:"iat"`
}

FIWARE / VCVerifier / 17800152848

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous