com.nimbusds.oauth2.sdk.auth.verifier

Class ClientAuthenticationVerifier<T>

java.lang.Object

com.nimbusds.oauth2.sdk.auth.verifier.ClientAuthenticationVerifier<T>

@ThreadSafe
public class ClientAuthenticationVerifier<T>
extends java.lang.Object

Client authentication verifier.

Related specifications:

• OAuth 2.0 (RFC 6749), sections 2.3.1 and 3.2.1.
• OpenID Connect Core 1.0, section 9.
• JSON Web Token (JWT) Profile for OAuth 2.0 Client Authentication and Authorization Grants (RFC 7523).

Constructor Summary

Constructors

Constructor and Description
ClientAuthenticationVerifier(ClientCredentialsSelector<T> clientCredentialsSelector, java.util.Set<Audience> expectedAudience) Creates a new client authentication verifier.

Method Summary

Methods

Modifier and Type	Method and Description
ClientCredentialsSelector<T>	getClientCredentialsSelector() Returns the client credentials selector.
java.util.Set<Audience>	getExpectedAudience() Returns the permitted audience values in JWT authentication assertions.
boolean	verify(ClientAuthentication clientAuth, Context<T> context) Verifies a client authentication request.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ClientAuthenticationVerifier

public ClientAuthenticationVerifier(ClientCredentialsSelector<T> clientCredentialsSelector,
                            java.util.Set<Audience> expectedAudience)

Creates a new client authentication verifier.

Parameters:

clientCredentialsSelector - The client credentials selector. Must not be null.

expectedAudience - The permitted audience (aud) claim values in JWT authentication assertions. Must not be empty or null. Should typically contain the token endpoint URI and for OpenID provider it may also include the issuer URI.

Method Detail

getClientCredentialsSelector

public ClientCredentialsSelector<T> getClientCredentialsSelector()

Returns the client credentials selector.

Returns:

The client credentials selector.

getExpectedAudience

public java.util.Set<Audience> getExpectedAudience()

Returns the permitted audience values in JWT authentication assertions.

Returns:

The permitted audience (aud) claim values.

verify

public boolean verify(ClientAuthentication clientAuth,
             Context<T> context)
               throws com.nimbusds.jose.JOSEException

Verifies a client authentication request.

Parameters:

clientAuth - The client authentication. Must not be null.

context - Additional context to be passed to the client credentials selector. May be null.

Returns:

true if the client was successfully authenticated, false if the authentication failed due to an unknown client, invalid credential or unsupported authentication method.

Throws:

com.nimbusds.jose.JOSEException