com.nimbusds.openid.connect.sdk.id

Class SIVAESBasedPairwiseSubjectCodec

java.lang.Object

com.nimbusds.openid.connect.sdk.id.PairwiseSubjectCodec

com.nimbusds.openid.connect.sdk.id.SIVAESBasedPairwiseSubjectCodec

@ThreadSafe
public class SIVAESBasedPairwiseSubjectCodec
extends PairwiseSubjectCodec

SIV AES - based encoder / decoder of pairwise subject identifiers. Requires a 256, 384, or 512-bit secret key. Reversal is supported.

The plain text is formatted as follows ('|' as delimiter):

 sector_id|local_sub
 

Related specifications:

• Synthetic Initialization Vector (SIV) Authenticated Encryption Using the Advanced Encryption Standard (AES) (RFC 5297).
• OpenID Connect Core 1.0, section 8.1.

Field Summary

Fields inherited from class com.nimbusds.openid.connect.sdk.id.PairwiseSubjectCodec

CHARSET

Constructor Summary

Constructors

Constructor and Description
SIVAESBasedPairwiseSubjectCodec(SecretKey secretKey) Creates a new SIV AES - based codec for pairwise subject identifiers.

Method Summary

Modifier and Type	Method and Description
org.apache.commons.lang3.tuple.Pair<SectorID,Subject>	decode(Subject pairwiseSubject) Decodes the specified pairwise subject identifier to produce the matching sector identifier and local subject.
Subject	encode(SectorID sectorID, Subject localSub) Encodes a new pairwise subject identifier from the specified sector identifier and local subject.
SecretKey	getSecretKey() Returns the secret key.

Methods inherited from class com.nimbusds.openid.connect.sdk.id.PairwiseSubjectCodec

encode, getProvider, getSalt, setProvider

Methods inherited from class java.lang.Object

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

Constructor Detail

SIVAESBasedPairwiseSubjectCodec

public SIVAESBasedPairwiseSubjectCodec(SecretKey secretKey)

Creates a new SIV AES - based codec for pairwise subject identifiers.

Parameters:

secretKey - A 256, 384, or 512-bit secret key. Must not be null.

Method Detail

getSecretKey

public SecretKey getSecretKey()

Returns the secret key.

Returns:

The key.

encode

public Subject encode(SectorID sectorID,
                      Subject localSub)

Description copied from class: PairwiseSubjectCodec

Encodes a new pairwise subject identifier from the specified sector identifier and local subject.

Specified by:

encode in class PairwiseSubjectCodec

Parameters:

sectorID - The sector identifier. Must not be null.

localSub - The local subject identifier. Must not be null.

Returns:

The pairwise subject identifier.

decode

public org.apache.commons.lang3.tuple.Pair<SectorID,Subject> decode(Subject pairwiseSubject)
                                                             throws InvalidPairwiseSubjectException

Description copied from class: PairwiseSubjectCodec

Decodes the specified pairwise subject identifier to produce the matching sector identifier and local subject. Throws a UnsupportedOperationException. Codecs that support pairwise subject identifier reversal should override this method.

Overrides:

decode in class PairwiseSubjectCodec

Parameters:

pairwiseSubject - The pairwise subject identifier. Must be valid and not null.

Returns:

The matching sector identifier and local subject.

Throws:

InvalidPairwiseSubjectException - If the pairwise subject is invalid.