com.nimbusds.openid.connect.sdk.id.PairwiseSubjectCodec Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of oauth2-oidc-sdk Show documentation
Show all versions of oauth2-oidc-sdk Show documentation
OAuth 2.0 SDK with OpenID Connection extensions for developing
client and server applications.
/*
* 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.id;
import java.net.URI;
import java.nio.charset.Charset;
import java.security.Provider;
import java.util.Map;
import com.nimbusds.oauth2.sdk.id.Subject;
import net.jcip.annotations.ThreadSafe;
/**
* Encoder and decoder of pairwise subject identifiers. The encoder algorithms
* must be deterministic, to ensure a given set of inputs always produces an
* identical pairwise subject identifier.
*
* Decoding pairwise subject identifiers is optional, and is implemented by
* algorithms that supported reversal (typically with encryption-based codecs).
* Hash-based codecs don't support reversal.
*
*
Codec implementations thread-safe.
*
*
Related specifications:
*
*
* - OpenID Connect Core 1.0, section 8.1.
*
*/
@ThreadSafe
public abstract class PairwiseSubjectCodec {
/**
* The charset (UTF-8) for string to byte conversions.
*/
public static final Charset CHARSET = Charset.forName("UTF-8");
/**
* The salt.
*/
private final byte[] salt;
/**
* The security provider.
*/
private Provider provider;
/**
* Creates a new codec for pairwise subject identifiers.
*
* @param salt The salt, {@code null} if not required.
*/
public PairwiseSubjectCodec(final byte[] salt) {
this.salt = salt;
}
/**
* Returns the salt.
*
* @return The salt, {@code null} if not required.
*/
public byte[] getSalt() {
return salt;
}
/**
* Gets the security provider for cryptographic operations.
*
* @return The security provider, {@code null} if not specified
* (implies the default one).
*/
public Provider getProvider() {
return provider;
}
/**
* Sets the security provider for cryptographic operations.
*
* @param provider The security provider, {@code null} if not specified
* (implies the default one).
*/
public void setProvider(final Provider provider) {
this.provider = provider;
}
/**
* Encodes a new pairwise subject identifier from the specified sector
* identifier URI and local subject.
*
* @param sectorURI The sector identifier URI. Its scheme should be
* "https", must include a host portion and must not
* be {@code null}.
* @param localSub The local subject identifier. Must not be
* {@code null}.
*
* @return The pairwise subject identifier.
*/
public Subject encode(final URI sectorURI, final Subject localSub) {
return encode(new SectorID(sectorURI), localSub);
}
/**
* Encodes a new pairwise subject identifier from the specified sector
* identifier and local subject.
*
* @param sectorID The sector identifier. Must not be
* {@code null}.
* @param localSub The local subject identifier. Must not be
* {@code null}.
*
* @return The pairwise subject identifier.
*/
public abstract Subject encode(final SectorID sectorID, final Subject localSub);
/**
* Decodes the specified pairwise subject identifier to produce the
* matching sector identifier and local subject. Throws a
* {@link UnsupportedOperationException}. Codecs that support pairwise
* subject identifier reversal should override this method.
*
* @param pairwiseSubject The pairwise subject identifier. Must be
* valid and not {@code null}.
*
* @return The matching sector identifier and local subject.
*
* @throws InvalidPairwiseSubjectException If the pairwise subject is
* invalid.
*/
public Map.Entry decode(final Subject pairwiseSubject)
throws InvalidPairwiseSubjectException {
throw new UnsupportedOperationException("Pairwise subject decoding is not supported");
}
}