Package org.oa4mp.server.loader.oauth2.storage.keys

Class KERecord

java.lang.Object

edu.uiuc.ncsa.security.core.util.IdentifiableImpl

edu.uiuc.ncsa.security.storage.monitored.Monitored

org.oa4mp.server.loader.oauth2.storage.keys.KERecord

All Implemented Interfaces:

edu.uiuc.ncsa.security.core.DateComparable, edu.uiuc.ncsa.security.core.Identifiable, Serializable, Cloneable

public class KERecord
extends edu.uiuc.ncsa.security.storage.monitored.Monitored

Store entry that models a single JWK key. It contains all the administrative information for the key, as well as the actual key itself.

Each key has a VI (no VI means default). Much of this is usually also in the key itself, but pulling it out allows for searching and better management.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected String	alg
protected Date	exp
protected Date	iat
protected Boolean	isDefault
protected Boolean	isValid
protected edu.uiuc.ncsa.security.util.jwk.JSONWebKey	jwk
protected String	kid
protected String	kty
protected Date	nbf
protected String	use
protected URI	vi

Constructor Summary

Constructors

Constructor	Description
KERecord(edu.uiuc.ncsa.security.core.Identifier identifier)

Method Summary

Modifier and Type	Method	Description
void	fromJWK(edu.uiuc.ncsa.security.util.jwk.JSONWebKey jwk, boolean isDefault)	Imports the JSONWebKey into this record.
String	getAlg()
Boolean	getDefault()
Date	getExp()
Date	getIat()
edu.uiuc.ncsa.security.util.jwk.JSONWebKey	getJwk()	Gets the stored version of this key with little or no acocunting information.
String	getKid()
String	getKty()
Date	getNbf()
String	getUse()
Boolean	getValid()
URI	getVi()
boolean	hasValidDate()	Checks that the nbf (not before) date has passed
boolean	hasVI()	If there is a virtual issuer set.
boolean	isExpired()	Has the exp date of this record passed?
void	setAlg(String alg)
void	setDefault(Boolean aDefault)
void	setExp(Date exp)
void	setIat(Date iat)
void	setJwk(edu.uiuc.ncsa.security.util.jwk.JSONWebKey jwk)
void	setKid(String kid)
void	setKty(String kty)
void	setNbf(Date nbf)
void	setUse(String use)
void	setValid(Boolean valid)
void	setVi(URI vi)
edu.uiuc.ncsa.security.util.jwk.JSONWebKey	toJWK()	Takes this record and returns the JSONWebKey with all fields set.
String	toString()

Methods inherited from class edu.uiuc.ncsa.security.storage.monitored.Monitored

clone, equals, getCreationTS, getLastAccessed, getLastModifiedTS, setCreationTS, setLastAccessed, setLastModifiedTS

Methods inherited from class edu.uiuc.ncsa.security.core.util.IdentifiableImpl

getDescription, getIdentifier, getIdentifierString, isReadOnly, setDescription, setIdentifier, setReadOnly

Methods inherited from class java.lang.Object

finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

alg

protected String alg

isValid

protected Boolean isValid

exp

protected Date exp

iat

protected Date iat

isDefault

protected Boolean isDefault

jwk

protected edu.uiuc.ncsa.security.util.jwk.JSONWebKey jwk

kid

protected String kid

kty

protected String kty

nbf

protected Date nbf

use

protected String use

vi

protected URI vi

Constructor Detail

KERecord

public KERecord(edu.uiuc.ncsa.security.core.Identifier identifier)

Method Detail

getAlg

public String getAlg()

setAlg

public void setAlg(String alg)

getValid

public Boolean getValid()

setValid

public void setValid(Boolean valid)

getExp

public Date getExp()

setExp

public void setExp(Date exp)

getIat

public Date getIat()

setIat

public void setIat(Date iat)

getDefault

public Boolean getDefault()

setDefault

public void setDefault(Boolean aDefault)

getJwk

public edu.uiuc.ncsa.security.util.jwk.JSONWebKey getJwk()

Gets the stored version of this key with little or no acocunting information. Use the toJWK() to convert this record to a usuable JWK.

Returns:

setJwk

public void setJwk(edu.uiuc.ncsa.security.util.jwk.JSONWebKey jwk)

getKid

public String getKid()

setKid

public void setKid(String kid)

getKty

public String getKty()

setKty

public void setKty(String kty)

getNbf

public Date getNbf()

setNbf

public void setNbf(Date nbf)

getUse

public String getUse()

setUse

public void setUse(String use)

getVi

public URI getVi()

setVi

public void setVi(URI vi)

hasVI

public boolean hasVI()

If there is a virtual issuer set. No VI means this is in the default issuer.

Returns:

fromJWK

public void fromJWK(edu.uiuc.ncsa.security.util.jwk.JSONWebKey jwk,
                    boolean isDefault)
             throws NoSuchAlgorithmException,
                    InvalidKeySpecException

Imports the JSONWebKey into this record. At the end, the recrod represents the web key. See also toJWK().

Note

The key is not set valid automatically, since that is not part of the actual key, nor is there a description or virtual issuer set.

Parameters:

jwk -

isDefault -

Throws:

NoSuchAlgorithmException

InvalidKeySpecException

toJWK

public edu.uiuc.ncsa.security.util.jwk.JSONWebKey toJWK()
                                                 throws NoSuchAlgorithmException,
                                                        InvalidKeySpecException

Takes this record and returns the JSONWebKey with all fields set. You should use this if you need to export the key for use and getJwk() if you need the raw, unprocessed key.

Returns:

Throws:

NoSuchAlgorithmException

InvalidKeySpecException

isExpired

public boolean isExpired()

Has the exp date of this record passed? True if expired.

Returns:

hasValidDate

public boolean hasValidDate()

Checks that the nbf (not before) date has passed

Returns:

toString

public String toString()

Overrides:

toString in class Object