com.nimbusds.jose.jwk

Class JWKMatcher

java.lang.Object

com.nimbusds.jose.jwk.JWKMatcher

@Immutable
public class JWKMatcher
extends Object

JSON Web Key (JWK) matcher. May be used to ensure a JWK matches a set of application-specific criteria.

Supported key matching criteria:

• Any, unspecified, one or more key types (typ).
• Any, unspecified, one or more key uses (use).
• Any, unspecified, one or more key operations (key_ops).
• Any, unspecified, one or more key algorithms (alg).
• Any, unspecified, one or more key identifiers (kid).
• Private only key.
• Public only key.

Matching by X.509 certificate URL, thumbprint and chain is not supported.

Version:

2015-04-15

Author:

Vladimir Dzhuvinov

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	JWKMatcher.Builder Builder for constructing JWK matchers.

Constructor Summary

Constructors

Constructor and Description
JWKMatcher(Set<KeyType> types, Set<KeyUse> uses, Set<KeyOperation> ops, Set<Algorithm> algs, Set<String> ids, boolean privateOnly, boolean publicOnly) Creates a new JSON Web Key (JWK) matcher.

Method Summary

Methods

Modifier and Type	Method and Description
Set<Algorithm>	getAlgorithms() Returns the JOSE algorithms to match.
Set<String>	getKeyIDs() Returns the key IDs to match.
Set<KeyOperation>	getKeyOperations() Returns the key operations to match.
Set<KeyType>	getKeyTypes() Returns the key types to match.
Set<KeyUse>	getKeyUses() Returns the public key uses to match.
boolean	isPrivateOnly() Returns true if only private keys are matched.
boolean	isPublicOnly() Returns true if only public keys are matched.
boolean	matches(JWK key) Returns true if the specified JWK matches.

Methods inherited from class java.lang.Object

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

Constructor Detail

JWKMatcher

public JWKMatcher(Set<KeyType> types,
          Set<KeyUse> uses,
          Set<KeyOperation> ops,
          Set<Algorithm> algs,
          Set<String> ids,
          boolean privateOnly,
          boolean publicOnly)

Creates a new JSON Web Key (JWK) matcher.

Parameters:

types - The key types to match, null if not specified.

uses - The public key uses to match, null if not specified.

ops - The key operations to match, null if not specified.

algs - The JOSE algorithms to match, null if not specified.

ids - The key IDs to match, null if not specified.

privateOnly - If true only private keys are matched.

publicOnly - If true only public keys are matched.

Method Detail

getKeyTypes

public Set<KeyType> getKeyTypes()

Returns the key types to match.

Returns:

The key types, null if not specified.

getKeyUses

public Set<KeyUse> getKeyUses()

Returns the public key uses to match.

Returns:

The public key uses, null if not specified.

getKeyOperations

public Set<KeyOperation> getKeyOperations()

Returns the key operations to match.

Returns:

The key operations, null if not specified.

getAlgorithms

public Set<Algorithm> getAlgorithms()

Returns the JOSE algorithms to match.

Returns:

The JOSE algorithms, null if not specified.

getKeyIDs

public Set<String> getKeyIDs()

Returns the key IDs to match.

Returns:

The key IDs, null if not specified.

isPrivateOnly

public boolean isPrivateOnly()

Returns true if only private keys are matched.

Returns:

true if only private keys are matched, else false.

isPublicOnly

public boolean isPublicOnly()

Returns true if only public keys are matched.

Returns:

true if only public keys are selected, else false.

matches

public boolean matches(JWK key)

Returns true if the specified JWK matches.

Parameters:

key - The JSON Web Key (JWK). Must not be null.

Returns:

true if the JWK matches, else false.