Package io.jans.as.model.crypto

Class AbstractCryptoProvider

java.lang.Object

io.jans.as.model.crypto.AbstractCryptoProvider

Direct Known Subclasses:

AuthCryptoProvider, ElevenCryptoProvider

public abstract class AbstractCryptoProvider
extends Object

Version:

October 26, 2021

Author:

Javier Rojas Blum, Sergey Manoylo

Field Summary

Fields

Modifier and Type	Field	Description
protected static org.apache.log4j.Logger	LOG

Constructor Summary

Constructors

Constructor	Description
AbstractCryptoProvider()

Method Summary

Modifier and Type	Method	Description
protected void	checkKeyExpiration(String alias, Long expirationTime)
abstract boolean	containsKey(String keyId)
abstract boolean	deleteKey(String keyId)
static org.json.JSONObject	generateJwks(AbstractCryptoProvider cryptoProvider, AppConfiguration configuration)
abstract org.json.JSONObject	generateKey(Algorithm algorithm, Long expirationTime)
abstract org.json.JSONObject	generateKey(Algorithm algorithm, Long expirationTime, int keyLength)
abstract org.json.JSONObject	generateKey(Algorithm algorithm, Long expirationTime, int keyLength, KeyOpsType keyOpsType)
io.jans.eleven.model.JwksRequestParam	getJwksRequestParam(org.json.JSONObject jwkJsonObject)
String	getKeyId(JSONWebKeySet jsonWebKeySet, Algorithm algorithm, Use use, KeyOpsType keyOps)
int	getKeyRegenerationIntervalInDays()
List<String>	getKeys()
abstract PrivateKey	getPrivateKey(String keyId)
abstract PublicKey	getPublicKey(String alias)
PublicKey	getPublicKey(String alias, org.json.JSONObject jwks, Algorithm requestedAlgorithm)
void	setKeyRegenerationIntervalInDays(int keyRegenerationIntervalInDays)
abstract String	sign(String signingInput, String keyId, String sharedSecret, SignatureAlgorithm signatureAlgorithm)
abstract boolean	verifySignature(String signingInput, String encodedSignature, String keyId, org.json.JSONObject jwks, String sharedSecret, SignatureAlgorithm signatureAlgorithm)

Methods inherited from class java.lang.Object

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

Field Detail

LOG

protected static final org.apache.log4j.Logger LOG

Constructor Detail

AbstractCryptoProvider

public AbstractCryptoProvider()

Method Detail

generateKey

public abstract org.json.JSONObject generateKey(Algorithm algorithm,
                                                Long expirationTime)
                                         throws CryptoProviderException

Throws:

CryptoProviderException

generateKey

public abstract org.json.JSONObject generateKey(Algorithm algorithm,
                                                Long expirationTime,
                                                int keyLength)
                                         throws CryptoProviderException

Throws:

CryptoProviderException

generateKey

public abstract org.json.JSONObject generateKey(Algorithm algorithm,
                                                Long expirationTime,
                                                int keyLength,
                                                KeyOpsType keyOpsType)
                                         throws CryptoProviderException

Throws:

CryptoProviderException

sign

public abstract String sign(String signingInput,
                            String keyId,
                            String sharedSecret,
                            SignatureAlgorithm signatureAlgorithm)
                     throws CryptoProviderException

Throws:

CryptoProviderException

verifySignature

public abstract boolean verifySignature(String signingInput,
                                        String encodedSignature,
                                        String keyId,
                                        org.json.JSONObject jwks,
                                        String sharedSecret,
                                        SignatureAlgorithm signatureAlgorithm)
                                 throws CryptoProviderException

Throws:

CryptoProviderException

deleteKey

public abstract boolean deleteKey(String keyId)
                           throws CryptoProviderException

Throws:

CryptoProviderException

containsKey

public abstract boolean containsKey(String keyId)

getKeys

public List<String> getKeys()

getPrivateKey

public abstract PrivateKey getPrivateKey(String keyId)
                                  throws CryptoProviderException

Throws:

CryptoProviderException

getPublicKey

public abstract PublicKey getPublicKey(String alias)
                                throws CryptoProviderException

Throws:

CryptoProviderException

getKeyId

public String getKeyId(JSONWebKeySet jsonWebKeySet,
                       Algorithm algorithm,
                       Use use,
                       KeyOpsType keyOps)
                throws CryptoProviderException

Throws:

CryptoProviderException

getJwksRequestParam

public io.jans.eleven.model.JwksRequestParam getJwksRequestParam(org.json.JSONObject jwkJsonObject)

generateJwks

public static org.json.JSONObject generateJwks(AbstractCryptoProvider cryptoProvider,
                                               AppConfiguration configuration)

getPublicKey

public PublicKey getPublicKey(String alias,
                              org.json.JSONObject jwks,
                              Algorithm requestedAlgorithm)
                       throws CryptoProviderException

Throws:

CryptoProviderException

checkKeyExpiration

protected void checkKeyExpiration(String alias,
                                  Long expirationTime)

getKeyRegenerationIntervalInDays

public int getKeyRegenerationIntervalInDays()

setKeyRegenerationIntervalInDays

public void setKeyRegenerationIntervalInDays(int keyRegenerationIntervalInDays)