Examples with OAuth2AccessTokenRespDTO org.wso2.carbon.identity.oauth2.dto.OAuth2AccessTokenRespDTO used on opensource projects

Example 41 with OAuth2AccessTokenRespDTO

use of org.wso2.carbon.identity.oauth2.dto.OAuth2AccessTokenRespDTO in project identity-inbound-auth-oauth by wso2-extensions.

the class ClaimsUtil method addUserAttributesToCache.

/**
 * This method is responsible for adding user attributes to cache.
 * @param tokenRespDTO Token response.
 * @param msgCtx Request message context.
 * @param userAttributes Relevant user attributes.
 */
public static void addUserAttributesToCache(OAuth2AccessTokenRespDTO tokenRespDTO, OAuthTokenReqMessageContext msgCtx, Map<ClaimMapping, String> userAttributes) {
    AuthorizationGrantCacheKey authorizationGrantCacheKey = new AuthorizationGrantCacheKey(tokenRespDTO.getAccessToken());
    AuthorizationGrantCacheEntry authorizationGrantCacheEntry = new AuthorizationGrantCacheEntry(userAttributes);
    authorizationGrantCacheEntry.setSubjectClaim(msgCtx.getAuthorizedUser().getAuthenticatedSubjectIdentifier());
    Object hasNonOIDCClaimsProperty = msgCtx.getProperty(OIDCConstants.HAS_NON_OIDC_CLAIMS);
    if (hasNonOIDCClaimsProperty != null) {
        authorizationGrantCacheEntry.setHasNonOIDCClaims((Boolean) hasNonOIDCClaimsProperty);
    } else {
        authorizationGrantCacheEntry.setHasNonOIDCClaims(false);
    }
    if (StringUtils.isNotBlank(tokenRespDTO.getTokenId())) {
        authorizationGrantCacheEntry.setTokenId(tokenRespDTO.getTokenId());
    }
    long validityPeriod = TimeUnit.MILLISECONDS.toNanos(tokenRespDTO.getExpiresInMillis());
    authorizationGrantCacheEntry.setValidityPeriod(validityPeriod);
    AuthorizationGrantCache.getInstance().addToCacheByToken(authorizationGrantCacheKey, authorizationGrantCacheEntry);
}

Example 42 with OAuth2AccessTokenRespDTO

use of org.wso2.carbon.identity.oauth2.dto.OAuth2AccessTokenRespDTO in project identity-inbound-auth-oauth by wso2-extensions.

the class AccessTokenIssuer method issue.

/**
 * Issue access token using the respective grant handler and client authentication handler.
 *
 * @param tokenReqDTO
 * @return access token response
 * @throws IdentityException
 * @throws InvalidOAuthClientException
 */
public OAuth2AccessTokenRespDTO issue(OAuth2AccessTokenReqDTO tokenReqDTO) throws IdentityException {
    String grantType = tokenReqDTO.getGrantType();
    OAuth2AccessTokenRespDTO tokenRespDTO = null;
    AuthorizationGrantHandler authzGrantHandler = authzGrantHandlers.get(grantType);
    OAuthTokenReqMessageContext tokReqMsgCtx = new OAuthTokenReqMessageContext(tokenReqDTO);
    boolean isRefreshRequest = GrantType.REFRESH_TOKEN.toString().equals(grantType);
    triggerPreListeners(tokenReqDTO, tokReqMsgCtx, isRefreshRequest);
    OAuthClientAuthnContext oAuthClientAuthnContext = tokenReqDTO.getoAuthClientAuthnContext();
    if (oAuthClientAuthnContext == null) {
        if (LoggerUtils.isDiagnosticLogsEnabled()) {
            Map<String, Object> params = new HashMap<>();
            params.put("clientId", tokenReqDTO.getClientId());
            if (StringUtils.isNotBlank(tokenReqDTO.getClientSecret())) {
                params.put("clientSecret", tokenReqDTO.getClientSecret().replaceAll(".", "*"));
            }
            LoggerUtils.triggerDiagnosticLogEvent(OAuthConstants.LogConstants.OAUTH_INBOUND_SERVICE, params, OAuthConstants.LogConstants.FAILED, "OAuth client authentication failed.", "issue-access-token", null);
        }
        oAuthClientAuthnContext = new OAuthClientAuthnContext();
        oAuthClientAuthnContext.setAuthenticated(false);
        oAuthClientAuthnContext.setErrorMessage("Client Authentication Failed");
        oAuthClientAuthnContext.setErrorCode(OAuthError.TokenResponse.INVALID_REQUEST);
    }
    // whether the grant type is confidential or not.
    if (oAuthClientAuthnContext.isMultipleAuthenticatorsEngaged()) {
        if (LoggerUtils.isDiagnosticLogsEnabled()) {
            Map<String, Object> params = new HashMap<>();
            params.put("clientId", tokenReqDTO.getClientId());
            params.put("clientAuthenticators", oAuthClientAuthnContext.getExecutedAuthenticators());
            LoggerUtils.triggerDiagnosticLogEvent(OAuthConstants.LogConstants.OAUTH_INBOUND_SERVICE, params, OAuthConstants.LogConstants.FAILED, "The client MUST NOT use more than one authentication method per request.", "issue-access-token", null);
        }
        tokenRespDTO = handleError(OAuth2ErrorCodes.INVALID_REQUEST, "The client MUST NOT use more than one " + "authentication method in each", tokenReqDTO);
        setResponseHeaders(tokReqMsgCtx, tokenRespDTO);
        triggerPostListeners(tokenReqDTO, tokenRespDTO, tokReqMsgCtx, isRefreshRequest);
        return tokenRespDTO;
    }
    boolean isAuthenticated = oAuthClientAuthnContext.isAuthenticated();
    if (authzGrantHandler == null) {
        String errorMsg = "Unsupported grant type : " + grantType + ", is used.";
        if (log.isDebugEnabled()) {
            log.debug(errorMsg);
        }
        if (LoggerUtils.isDiagnosticLogsEnabled()) {
            Map<String, Object> params = new HashMap<>();
            params.put("clientId", tokenReqDTO.getClientId());
            params.put("grantType", grantType);
            LoggerUtils.triggerDiagnosticLogEvent(OAuthConstants.LogConstants.OAUTH_INBOUND_SERVICE, params, OAuthConstants.LogConstants.FAILED, "Unsupported grant type.", "issue-access-token", null);
        }
        tokenRespDTO = handleError(OAuthError.TokenResponse.UNSUPPORTED_GRANT_TYPE, errorMsg, tokenReqDTO);
        setResponseHeaders(tokReqMsgCtx, tokenRespDTO);
        triggerPostListeners(tokenReqDTO, tokenRespDTO, tokReqMsgCtx, isRefreshRequest);
        return tokenRespDTO;
    }
    // If the client is not confidential then there is no need to authenticate the client.
    if (!authzGrantHandler.isConfidentialClient() && StringUtils.isNotEmpty(oAuthClientAuthnContext.getClientId())) {
        isAuthenticated = true;
    }
    if (!isAuthenticated && !oAuthClientAuthnContext.isPreviousAuthenticatorEngaged() && authzGrantHandler.isConfidentialClient()) {
        if (LoggerUtils.isDiagnosticLogsEnabled()) {
            Map<String, Object> params = new HashMap<>();
            params.put("clientId", tokenReqDTO.getClientId());
            LoggerUtils.triggerDiagnosticLogEvent(OAuthConstants.LogConstants.OAUTH_INBOUND_SERVICE, params, OAuthConstants.LogConstants.FAILED, "Unsupported client authentication method.", "issue-access-token", null);
        }
        tokenRespDTO = handleError(OAuth2ErrorCodes.INVALID_CLIENT, "Unsupported Client Authentication Method!", tokenReqDTO);
        setResponseHeaders(tokReqMsgCtx, tokenRespDTO);
        triggerPostListeners(tokenReqDTO, tokenRespDTO, tokReqMsgCtx, isRefreshRequest);
        return tokenRespDTO;
    }
    if (!isAuthenticated) {
        if (LoggerUtils.isDiagnosticLogsEnabled()) {
            Map<String, Object> params = new HashMap<>();
            params.put("clientId", tokenReqDTO.getClientId());
            LoggerUtils.triggerDiagnosticLogEvent(OAuthConstants.LogConstants.OAUTH_INBOUND_SERVICE, params, OAuthConstants.LogConstants.FAILED, "Client authentication failed. " + oAuthClientAuthnContext.getErrorMessage(), "issue-access-token", null);
        }
        tokenRespDTO = handleError(oAuthClientAuthnContext.getErrorCode(), oAuthClientAuthnContext.getErrorMessage(), tokenReqDTO);
        setResponseHeaders(tokReqMsgCtx, tokenRespDTO);
        triggerPostListeners(tokenReqDTO, tokenRespDTO, tokReqMsgCtx, isRefreshRequest);
        return tokenRespDTO;
    }
    // loading the stored application data
    OAuthAppDO oAuthAppDO = getOAuthApplication(tokenReqDTO.getClientId());
    // set the tenantDomain of the SP in the tokenReqDTO
    // Indirectly we can say that the tenantDomain of the SP is the tenantDomain of the user who created SP.
    // This is done to avoid having to send the tenantDomain as a query param to the token endpoint
    String tenantDomainOfApp = OAuth2Util.getTenantDomainOfOauthApp(oAuthAppDO);
    validateRequestTenantDomain(tenantDomainOfApp);
    tokenReqDTO.setTenantDomain(tenantDomainOfApp);
    tokReqMsgCtx.addProperty(OAUTH_APP_DO, oAuthAppDO);
    boolean isOfTypeApplicationUser = authzGrantHandler.isOfTypeApplicationUser();
    if (!isOfTypeApplicationUser) {
        tokReqMsgCtx.setAuthorizedUser(oAuthAppDO.getAppOwner());
        tokReqMsgCtx.addProperty(OAuthConstants.UserType.USER_TYPE, OAuthConstants.UserType.APPLICATION);
    } else {
        tokReqMsgCtx.addProperty(OAuthConstants.UserType.USER_TYPE, OAuthConstants.UserType.APPLICATION_USER);
    }
    boolean isAuthorizedClient = false;
    String error = "The authenticated client is not authorized to use this authorization grant type";
    try {
        isAuthorizedClient = authzGrantHandler.isAuthorizedClient(tokReqMsgCtx);
    } catch (IdentityOAuth2Exception e) {
        if (log.isDebugEnabled()) {
            log.debug("Error occurred while validating client for authorization", e);
        }
        LoggerUtils.triggerDiagnosticLogEvent(OAuthConstants.LogConstants.OAUTH_INBOUND_SERVICE, null, OAuthConstants.LogConstants.FAILED, "System error occurred.", "issue-access-token", null);
        error = e.getMessage();
    }
    if (!isAuthorizedClient) {
        if (log.isDebugEnabled()) {
            log.debug("Client Id: " + tokenReqDTO.getClientId() + " is not authorized to use grant type: " + grantType);
        }
        if (LoggerUtils.isDiagnosticLogsEnabled()) {
            Map<String, Object> params = new HashMap<>();
            params.put("clientId", tokenReqDTO.getClientId());
            params.put("grantType", grantType);
            LoggerUtils.triggerDiagnosticLogEvent(OAuthConstants.LogConstants.OAUTH_INBOUND_SERVICE, params, OAuthConstants.LogConstants.FAILED, "Client is not authorized to use the requested grant type.", "issue-access-token", null);
        }
        tokenRespDTO = handleError(OAuthError.TokenResponse.UNAUTHORIZED_CLIENT, error, tokenReqDTO);
        setResponseHeaders(tokReqMsgCtx, tokenRespDTO);
        triggerPostListeners(tokenReqDTO, tokenRespDTO, tokReqMsgCtx, isRefreshRequest);
        return tokenRespDTO;
    }
    boolean isValidGrant = false;
    error = "Provided Authorization Grant is invalid";
    String errorCode = OAuthError.TokenResponse.INVALID_GRANT;
    try {
        isValidGrant = authzGrantHandler.validateGrant(tokReqMsgCtx);
    } catch (IdentityOAuth2Exception e) {
        if (log.isDebugEnabled()) {
            log.debug("Error occurred while validating grant", e);
        }
        if (e.getErrorCode() != null) {
            errorCode = e.getErrorCode();
        }
        error = e.getMessage();
        if (e.getErrorCode() != null) {
            errorCode = e.getErrorCode();
        }
    }
    if (tokReqMsgCtx.getAuthorizedUser() != null && tokReqMsgCtx.getAuthorizedUser().isFederatedUser()) {
        tokReqMsgCtx.getAuthorizedUser().setTenantDomain(tenantDomainOfApp);
    }
    if (!isValidGrant) {
        if (log.isDebugEnabled()) {
            log.debug("Invalid Grant provided by the client Id: " + tokenReqDTO.getClientId());
        }
        tokenRespDTO = handleError(errorCode, error, tokenReqDTO);
        setResponseHeaders(tokReqMsgCtx, tokenRespDTO);
        triggerPostListeners(tokenReqDTO, tokenRespDTO, tokReqMsgCtx, isRefreshRequest);
        return tokenRespDTO;
    }
    boolean isAuthorized = authzGrantHandler.authorizeAccessDelegation(tokReqMsgCtx);
    if (!isAuthorized) {
        if (log.isDebugEnabled()) {
            log.debug("Invalid authorization for client Id : " + tokenReqDTO.getClientId());
        }
        tokenRespDTO = handleError(OAuthError.TokenResponse.UNAUTHORIZED_CLIENT, "Unauthorized Client!", tokenReqDTO);
        setResponseHeaders(tokReqMsgCtx, tokenRespDTO);
        triggerPostListeners(tokenReqDTO, tokenRespDTO, tokReqMsgCtx, isRefreshRequest);
        return tokenRespDTO;
    }
    List<String> allowedScopes = OAuthServerConfiguration.getInstance().getAllowedScopes();
    List<String> requestedAllowedScopes = new ArrayList<>();
    String[] requestedScopes = tokReqMsgCtx.getScope();
    List<String> scopesToBeValidated = new ArrayList<>();
    if (requestedScopes != null) {
        for (String scope : requestedScopes) {
            if (OAuth2Util.isAllowedScope(allowedScopes, scope)) {
                requestedAllowedScopes.add(scope);
            } else {
                scopesToBeValidated.add(scope);
            }
        }
        tokReqMsgCtx.setScope(scopesToBeValidated.toArray(new String[0]));
    }
    String[] authorizedInternalScopes = new String[0];
    boolean isManagementApp = getServiceProvider(tokenReqDTO).isManagementApp();
    if (isManagementApp) {
        if (log.isDebugEnabled()) {
            log.debug("Handling the internal scope validation.");
        }
        // Execute Internal SCOPE Validation.
        JDBCPermissionBasedInternalScopeValidator scopeValidator = new JDBCPermissionBasedInternalScopeValidator();
        authorizedInternalScopes = scopeValidator.validateScope(tokReqMsgCtx);
        // Execute internal console scopes validation.
        if (IdentityUtil.isSystemRolesEnabled()) {
            RoleBasedInternalScopeValidator roleBasedInternalScopeValidator = new RoleBasedInternalScopeValidator();
            String[] roleBasedInternalConsoleScopes = roleBasedInternalScopeValidator.validateScope(tokReqMsgCtx);
            authorizedInternalScopes = (String[]) ArrayUtils.addAll(authorizedInternalScopes, roleBasedInternalConsoleScopes);
        }
    } else {
        if (log.isDebugEnabled()) {
            log.debug("Skipping the internal scope validation as the application is not" + " configured as Management App");
        }
    }
    // Clear the internal scopes. Internal scopes should only handle in JDBCPermissionBasedInternalScopeValidator.
    // Those scopes should not send to the other scopes validators.
    // Thus remove the scopes from the tokReqMsgCtx. Will be added to the response after executing
    // the other scope validators.
    removeInternalScopes(tokReqMsgCtx);
    // Adding the authorized internal scopes to tokReqMsgCtx for any special validators to use.
    tokReqMsgCtx.setAuthorizedInternalScopes(authorizedInternalScopes);
    boolean isDropUnregisteredScopes = OAuthServerConfiguration.getInstance().isDropUnregisteredScopes();
    if (isDropUnregisteredScopes) {
        if (log.isDebugEnabled()) {
            log.debug("DropUnregisteredScopes config is enabled. Attempting to drop unregistered scopes.");
        }
        String[] filteredScopes = OAuth2Util.dropUnregisteredScopes(tokReqMsgCtx.getScope(), tokReqMsgCtx.getOauth2AccessTokenReqDTO().getTenantDomain());
        tokReqMsgCtx.setScope(filteredScopes);
    }
    boolean isValidScope = authzGrantHandler.validateScope(tokReqMsgCtx);
    if (isValidScope) {
        if (LoggerUtils.isDiagnosticLogsEnabled()) {
            Map<String, Object> params = new HashMap<>();
            params.put("clientId", tokenReqDTO.getClientId());
            if (ArrayUtils.isNotEmpty(tokenReqDTO.getScope())) {
                params.put("scope", Arrays.asList(tokenReqDTO.getScope()));
            }
            LoggerUtils.triggerDiagnosticLogEvent(OAuthConstants.LogConstants.OAUTH_INBOUND_SERVICE, params, OAuthConstants.LogConstants.SUCCESS, "OAuth scope validation is successful.", "validate-scope", null);
        }
        // Add authorized internal scopes to the request for sending in the response.
        addAuthorizedInternalScopes(tokReqMsgCtx, tokReqMsgCtx.getAuthorizedInternalScopes());
        addAllowedScopes(tokReqMsgCtx, requestedAllowedScopes.toArray(new String[0]));
    } else {
        if (log.isDebugEnabled()) {
            log.debug("Invalid scope provided by client Id: " + tokenReqDTO.getClientId());
        }
        if (LoggerUtils.isDiagnosticLogsEnabled()) {
            Map<String, Object> params = new HashMap<>();
            params.put("clientId", tokenReqDTO.getClientId());
            if (ArrayUtils.isNotEmpty(tokenReqDTO.getScope())) {
                params.put("scope", Arrays.asList(tokenReqDTO.getScope()));
            }
            LoggerUtils.triggerDiagnosticLogEvent(OAuthConstants.LogConstants.OAUTH_INBOUND_SERVICE, params, OAuthConstants.LogConstants.FAILED, "Invalid scope provided in the request.", "validate-scope", null);
        }
        tokenRespDTO = handleError(OAuthError.TokenResponse.INVALID_SCOPE, "Invalid Scope!", tokenReqDTO);
        setResponseHeaders(tokReqMsgCtx, tokenRespDTO);
        triggerPostListeners(tokenReqDTO, tokenRespDTO, tokReqMsgCtx, isRefreshRequest);
        return tokenRespDTO;
    }
    handleTokenBinding(tokenReqDTO, grantType, tokReqMsgCtx, oAuthAppDO);
    try {
        // set the token request context to be used by downstream handlers. This is introduced as a fix for
        // IDENTITY-4111.
        OAuth2Util.setTokenRequestContext(tokReqMsgCtx);
        AuthenticatedUser authorizedUser = tokReqMsgCtx.getAuthorizedUser();
        if (authorizedUser.getAuthenticatedSubjectIdentifier() == null) {
            authorizedUser.setAuthenticatedSubjectIdentifier(getSubjectClaim(getServiceProvider(tokReqMsgCtx.getOauth2AccessTokenReqDTO()), authorizedUser));
        }
        tokenRespDTO = authzGrantHandler.issue(tokReqMsgCtx);
        if (tokenRespDTO.isError()) {
            setResponseHeaders(tokReqMsgCtx, tokenRespDTO);
            return tokenRespDTO;
        }
    } finally {
        triggerPostListeners(tokenReqDTO, tokenRespDTO, tokReqMsgCtx, isRefreshRequest);
        // clears the token request context.
        OAuth2Util.clearTokenRequestContext();
    }
    tokenRespDTO.setCallbackURI(oAuthAppDO.getCallbackUrl());
    String[] scopes = tokReqMsgCtx.getScope();
    if (scopes != null && scopes.length > 0) {
        StringBuilder scopeString = new StringBuilder("");
        for (String scope : scopes) {
            scopeString.append(scope);
            scopeString.append(" ");
        }
        tokenRespDTO.setAuthorizedScopes(scopeString.toString().trim());
    }
    setResponseHeaders(tokReqMsgCtx, tokenRespDTO);
    // Do not change this log format as these logs use by external applications
    if (log.isDebugEnabled()) {
        log.debug("Access token issued to client Id: " + tokenReqDTO.getClientId() + " username: " + tokReqMsgCtx.getAuthorizedUser() + " and scopes: " + tokenRespDTO.getAuthorizedScopes());
    }
    if (LoggerUtils.isDiagnosticLogsEnabled()) {
        Map<String, Object> params = new HashMap<>();
        params.put("clientId", tokenReqDTO.getClientId());
        LoggerUtils.triggerDiagnosticLogEvent(OAuthConstants.LogConstants.OAUTH_INBOUND_SERVICE, params, OAuthConstants.LogConstants.SUCCESS, "Access token issued for the application.", "issue-access-token", null);
    }
    if (GrantType.AUTHORIZATION_CODE.toString().equals(grantType)) {
        // Should add user attributes to the cache before building the ID token.
        addUserAttributesAgainstAccessToken(tokenReqDTO, tokenRespDTO);
    }
    if (tokReqMsgCtx.getScope() != null && OAuth2Util.isOIDCAuthzRequest(tokReqMsgCtx.getScope())) {
        if (log.isDebugEnabled()) {
            log.debug("Issuing ID token for client: " + tokenReqDTO.getClientId());
        }
        IDTokenBuilder builder = OAuthServerConfiguration.getInstance().getOpenIDConnectIDTokenBuilder();
        try {
            String idToken = builder.buildIDToken(tokReqMsgCtx, tokenRespDTO);
            if (LoggerUtils.isDiagnosticLogsEnabled()) {
                Map<String, Object> params = new HashMap<>();
                params.put("clientId", tokenReqDTO.getClientId());
                LoggerUtils.triggerDiagnosticLogEvent(OAuthConstants.LogConstants.OAUTH_INBOUND_SERVICE, params, OAuthConstants.LogConstants.SUCCESS, "ID token issued for the application.", "issue-id-token", null);
            }
            tokenRespDTO.setIDToken(idToken);
        } catch (IDTokenValidationFailureException e) {
            log.error(e.getMessage());
            if (LoggerUtils.isDiagnosticLogsEnabled()) {
                Map<String, Object> params = new HashMap<>();
                params.put("clientId", tokenReqDTO.getClientId());
                LoggerUtils.triggerDiagnosticLogEvent(OAuthConstants.LogConstants.OAUTH_INBOUND_SERVICE, params, OAuthConstants.LogConstants.FAILED, "System error occurred.", "issue-id-token", null);
            }
            tokenRespDTO = handleError(OAuth2ErrorCodes.SERVER_ERROR, "Server Error", tokenReqDTO);
            return tokenRespDTO;
        }
    }
    if (GrantType.AUTHORIZATION_CODE.toString().equals(grantType)) {
        // Cache entry against the authorization code has no value beyond the token request.
        clearCacheEntryAgainstAuthorizationCode(getAuthorizationCode(tokenReqDTO));
    }
    return tokenRespDTO;
}