com.nimbusds.openid.connect.sdk.AuthenticationErrorResponse Maven / Gradle / Ivy
/*
* 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.openid.connect.sdk;
import java.net.URI;
import java.net.URISyntaxException;
import java.util.Collections;
import java.util.HashSet;
import java.util.Map;
import java.util.Set;
import net.jcip.annotations.Immutable;
import com.nimbusds.oauth2.sdk.*;
import com.nimbusds.oauth2.sdk.id.State;
import com.nimbusds.oauth2.sdk.http.HTTPRequest;
import com.nimbusds.oauth2.sdk.http.HTTPResponse;
import com.nimbusds.oauth2.sdk.util.URLUtils;
/**
* OpenID Connect authentication error response.
*
* Standard errors:
*
*
* - OAuth 2.0 authorisation errors:
*
* - {@link com.nimbusds.oauth2.sdk.OAuth2Error#INVALID_REQUEST}
*
- {@link com.nimbusds.oauth2.sdk.OAuth2Error#UNAUTHORIZED_CLIENT}
*
- {@link com.nimbusds.oauth2.sdk.OAuth2Error#ACCESS_DENIED}
*
- {@link com.nimbusds.oauth2.sdk.OAuth2Error#UNSUPPORTED_RESPONSE_TYPE}
*
- {@link com.nimbusds.oauth2.sdk.OAuth2Error#INVALID_SCOPE}
*
- {@link com.nimbusds.oauth2.sdk.OAuth2Error#SERVER_ERROR}
*
- {@link com.nimbusds.oauth2.sdk.OAuth2Error#TEMPORARILY_UNAVAILABLE}
*
* - OpenID Connect specific errors:
*
* - {@link OIDCError#INTERACTION_REQUIRED}
*
- {@link OIDCError#LOGIN_REQUIRED}
*
- {@link OIDCError#ACCOUNT_SELECTION_REQUIRED}
*
- {@link OIDCError#CONSENT_REQUIRED}
*
- {@link OIDCError#INVALID_REQUEST_URI}
*
- {@link OIDCError#INVALID_REQUEST_OBJECT}
*
- {@link OIDCError#REGISTRATION_NOT_SUPPORTED}
*
- {@link OIDCError#REQUEST_NOT_SUPPORTED}
*
- {@link OIDCError#REQUEST_URI_NOT_SUPPORTED}
*
*
*
*
* Example HTTP response:
*
*
* HTTP/1.1 302 Found
* Location: https://client.example.org/cb?
* error=invalid_request
* &error_description=the%20request%20is%20not%20valid%20or%20malformed
* &state=af0ifjsldkj
*
*
* Related specifications:
*
*
* - OpenID Connect Core 1.0, section 3.1.2.6.
*
- OAuth 2.0 (RFC 6749), sections 4.1.2.1 and 4.2.2.1.
*
- OAuth 2.0 Multiple Response Type Encoding Practices 1.0.
*
- OAuth 2.0 Form Post Response Mode 1.0.
*
*/
@Immutable
public class AuthenticationErrorResponse
extends AuthorizationErrorResponse
implements AuthenticationResponse {
/**
* The standard errors for an OpenID Connect authentication error
* response.
*/
private static final Set stdErrors = new HashSet<>();
static {
stdErrors.addAll(AuthorizationErrorResponse.getStandardErrors());
stdErrors.add(OIDCError.INTERACTION_REQUIRED);
stdErrors.add(OIDCError.LOGIN_REQUIRED);
stdErrors.add(OIDCError.ACCOUNT_SELECTION_REQUIRED);
stdErrors.add(OIDCError.CONSENT_REQUIRED);
stdErrors.add(OIDCError.INVALID_REQUEST_URI);
stdErrors.add(OIDCError.INVALID_REQUEST_OBJECT);
stdErrors.add(OIDCError.REGISTRATION_NOT_SUPPORTED);
stdErrors.add(OIDCError.REQUEST_NOT_SUPPORTED);
stdErrors.add(OIDCError.REQUEST_URI_NOT_SUPPORTED);
}
/**
* Gets the standard errors for an OpenID Connect authentication error
* response.
*
* @return The standard errors, as a read-only set.
*/
public static Set getStandardErrors() {
return Collections.unmodifiableSet(stdErrors);
}
/**
* Creates a new OpenID Connect authentication error response.
*
* @param redirectURI The base redirection URI. Must not be
* {@code null}.
* @param error The error. Should match one of the
* {@link #getStandardErrors standard errors} for an
* OpenID Connect authentication error response.
* Must not be {@code null}.
* @param state The state, {@code null} if not requested.
* @param rm The implied response mode, {@code null} if
* unknown.
*/
public AuthenticationErrorResponse(final URI redirectURI,
final ErrorObject error,
final State state,
final ResponseMode rm) {
super(redirectURI, error, state, rm);
}
/**
* Parses an OpenID Connect authentication error response.
*
* @param redirectURI The base redirection URI. Must not be
* {@code null}.
* @param params The response parameters to parse. Must not be
* {@code null}.
*
* @return The OpenID Connect authentication error response.
*
* @throws ParseException If the parameters couldn't be parsed to an
* OpenID Connect authentication error response.
*/
public static AuthenticationErrorResponse parse(final URI redirectURI,
final Map params)
throws ParseException {
AuthorizationErrorResponse resp = AuthorizationErrorResponse.parse(redirectURI, params);
return new AuthenticationErrorResponse(
resp.getRedirectionURI(),
resp.getErrorObject(),
resp.getState(),
null);
}
/**
* Parses an OpenID Connect authentication error response.
*
* Use a relative URI if the host, port and path details are not
* known:
*
*
* URI relUrl = new URI("https:///?error=invalid_request");
*
*
* Example URI:
*
*
* https://client.example.com/cb?
* error=invalid_request
* &error_description=the%20request%20is%20not%20valid%20or%20malformed
* &state=af0ifjsldkj
*
*
* @param uri The URI to parse. Can be absolute or relative, with a
* fragment or query string containing the authorisation
* response parameters. Must not be {@code null}.
*
* @return The OpenID Connect authentication error response.
*
* @throws ParseException If the URI couldn't be parsed to an OpenID
* Connect authentication error response.
*/
public static AuthenticationErrorResponse parse(final URI uri)
throws ParseException {
AuthorizationErrorResponse resp = AuthorizationErrorResponse.parse(uri);
return new AuthenticationErrorResponse(
resp.getRedirectionURI(),
resp.getErrorObject(),
resp.getState(),
null);
}
/**
* Parses an OpenID Connect authentication error response from the
* specified initial HTTP 302 redirect response generated at the
* authorisation endpoint.
*
* Example HTTP response:
*
*
* HTTP/1.1 302 Found
* Location: https://client.example.com/cb?error=invalid_request&state=af0ifjsldkj
*
*
* @param httpResponse The HTTP response to parse. Must not be
* {@code null}.
*
* @return The OpenID Connect authentication error response.
*
* @throws ParseException If the HTTP response couldn't be parsed to an
* OpenID Connect authentication error response.
*/
public static AuthenticationErrorResponse parse(final HTTPResponse httpResponse)
throws ParseException {
AuthorizationErrorResponse resp = AuthorizationErrorResponse.parse(httpResponse);
return new AuthenticationErrorResponse(
resp.getRedirectionURI(),
resp.getErrorObject(),
resp.getState(),
null);
}
/**
* Parses an OpenID Connect authentication error response from the
* specified HTTP request at the client redirection (callback) URI.
* Applies to {@code query}, {@code fragment} and {@code form_post}
* response modes.
*
* Example HTTP request (authorisation success):
*
*
* GET /cb?error=invalid_request&state=af0ifjsldkj HTTP/1.1
* Host: client.example.com
*
*
* @see #parse(HTTPResponse)
*
* @param httpRequest The HTTP request to parse. Must not be
* {@code null}.
*
* @throws ParseException If the HTTP request couldn't be parsed to an
* OpenID Connect authentication error response.
*/
public static AuthenticationErrorResponse parse(final HTTPRequest httpRequest)
throws ParseException {
final URI baseURI;
try {
baseURI = httpRequest.getURL().toURI();
} catch (URISyntaxException e) {
throw new ParseException(e.getMessage(), e);
}
if (httpRequest.getQuery() != null) {
// For query string and form_post response mode
return parse(baseURI, URLUtils.parseParameters(httpRequest.getQuery()));
} else if (httpRequest.getFragment() != null) {
// For fragment response mode (never available in actual HTTP request from browser)
return parse(baseURI, URLUtils.parseParameters(httpRequest.getFragment()));
} else {
throw new ParseException("Missing URI fragment, query string or post body");
}
}
}