All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.nimbusds.oauth2.sdk.TokenIntrospectionErrorResponse Maven / Gradle / Ivy

Go to download

OAuth 2.0 SDK with OpenID Connection extensions for developing client and server applications.

There is a newer version: 11.19.1
Show newest version
/*
 * oauth2-oidc-sdk
 *
 * Copyright 2012-2016, Connect2id Ltd and contributors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not use
 * this file except in compliance with the License. You may obtain a copy of the
 * License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software distributed
 * under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
 * CONDITIONS OF ANY KIND, either express or implied. See the License for the
 * specific language governing permissions and limitations under the License.
 */

package com.nimbusds.oauth2.sdk;


import java.util.Collections;
import java.util.HashSet;
import java.util.Set;

import static com.nimbusds.oauth2.sdk.http.HTTPResponse.SC_FORBIDDEN;
import static com.nimbusds.oauth2.sdk.http.HTTPResponse.SC_UNAUTHORIZED;

import com.nimbusds.oauth2.sdk.http.CommonContentTypes;
import com.nimbusds.oauth2.sdk.http.HTTPResponse;
import com.nimbusds.oauth2.sdk.token.BearerTokenError;
import net.jcip.annotations.Immutable;


/**
 * Token introspection error response.
 *
 * 

Standard errors: * *

    *
  • {@link OAuth2Error#INVALID_REQUEST} *
  • {@link OAuth2Error#INVALID_CLIENT} *
  • {@link BearerTokenError#MISSING_TOKEN} *
  • {@link BearerTokenError#INVALID_REQUEST} *
  • {@link BearerTokenError#INVALID_TOKEN} *
  • {@link BearerTokenError#INSUFFICIENT_SCOPE} *
* *

Example HTTP response: * *

 * HTTP/1.1 401 Unauthorized
 * WWW-Authenticate: Bearer realm="example.com",
 *                   error="invalid_token",
 *                   error_description="The access token expired"
 * 
* *

Related specifications: * *

    *
  • OAuth 2.0 Token Introspection (RFC 7662). *
*/ @Immutable public class TokenIntrospectionErrorResponse extends TokenIntrospectionResponse implements ErrorResponse { /** * The standard errors for a token introspection error response. */ private static final Set STANDARD_ERRORS; static { Set errors = new HashSet<>(); errors.add(OAuth2Error.INVALID_REQUEST); errors.add(OAuth2Error.INVALID_CLIENT); errors.add(BearerTokenError.MISSING_TOKEN); errors.add(BearerTokenError.INVALID_REQUEST); errors.add(BearerTokenError.INVALID_TOKEN); errors.add(BearerTokenError.INSUFFICIENT_SCOPE); STANDARD_ERRORS = Collections.unmodifiableSet(errors); } /** * Gets the standard errors for a token introspection error response. * * @return The standard errors, as a read-only set. */ public static Set getStandardErrors() { return STANDARD_ERRORS; } /** * The error. */ private final ErrorObject error; /** * Creates a new token introspection error response. * * @param error The error, {@code null} if not specified. */ public TokenIntrospectionErrorResponse(final ErrorObject error) { this.error = error; } @Override public ErrorObject getErrorObject() { return error; } @Override public boolean indicatesSuccess() { return false; } @Override public HTTPResponse toHTTPResponse() { // Determine HTTP status code int statusCode = error != null && error.getHTTPStatusCode() > 0 ? error.getHTTPStatusCode() : HTTPResponse.SC_BAD_REQUEST; HTTPResponse httpResponse = new HTTPResponse(statusCode); if (error == null) { return httpResponse; } // Print error object if available if (error instanceof BearerTokenError) { httpResponse.setWWWAuthenticate(((BearerTokenError) error).toWWWAuthenticateHeader()); } httpResponse.setContentType(CommonContentTypes.APPLICATION_JSON); httpResponse.setCacheControl("no-store"); httpResponse.setPragma("no-cache"); httpResponse.setContent(error.toJSONObject().toJSONString()); return httpResponse; } /** * Parses a token introspection error response from the specified HTTP * response. * * @param httpResponse The HTTP response to parse. Its status code must * not be 200 (OK). Must not be {@code null}. * * @return The token introspection error response. * * @throws ParseException If the HTTP response couldn't be parsed to a * token introspection error response. */ public static TokenIntrospectionErrorResponse parse(final HTTPResponse httpResponse) throws ParseException { httpResponse.ensureStatusCodeNotOK(); String wwwAuth = httpResponse.getWWWAuthenticate(); if ((httpResponse.getStatusCode() == SC_UNAUTHORIZED || httpResponse.getStatusCode() == SC_FORBIDDEN) && wwwAuth != null && wwwAuth.toLowerCase().startsWith("bearer")) { try { return new TokenIntrospectionErrorResponse(BearerTokenError.parse(httpResponse.getWWWAuthenticate())); } catch (ParseException e) { // try generic error parse ... } } return new TokenIntrospectionErrorResponse(ErrorObject.parse(httpResponse)); } }




© 2015 - 2024 Weber Informatics LLC | Privacy Policy