io.jsonwebtoken.impl.security

Class KeysBridge

java.lang.Object

io.jsonwebtoken.impl.security.KeysBridge

public final class KeysBridge
extends Object

Method Summary

Methods

Modifier and Type	Method and Description
static PrivateKeyBuilder	builder(PrivateKey key)
static SecretKeyBuilder	builder(SecretKey key)
static String	findAlgorithm(Key key)
static int	findBitLength(Key key) Returns the specified key's key length (in bits) if possible, or -1 if unable to determine the length.
static byte[]	findEncoded(Key key) Returns the specified key's available encoded bytes, or null if not available.
static byte[]	getEncoded(Key key)
static boolean	isGenericSecret(Key key)
static Password	password(char[] password)
static <K extends Key> K	root(K key) If the specified key is a KeySupplier, the 'root' (lowest level) key that may exist in a KeySupplier chain is returned, otherwise the key is returned.
static <K extends Key> K	root(KeySupplier<K> supplier)
static String	toString(Key key)

Methods inherited from class java.lang.Object

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

Method Detail

password

public static Password password(char[] password)

builder

public static SecretKeyBuilder builder(SecretKey key)

builder

public static PrivateKeyBuilder builder(PrivateKey key)

root

public static <K extends Key> K root(K key)

If the specified key is a KeySupplier, the 'root' (lowest level) key that may exist in a KeySupplier chain is returned, otherwise the key is returned.

Type Parameters:

K - the key type

Parameters:

key - the key to check if it is a KeySupplier

Returns:

the lowest-level/root key available.

root

public static <K extends Key> K root(KeySupplier<K> supplier)

findAlgorithm

public static String findAlgorithm(Key key)

findEncoded

public static byte[] findEncoded(Key key)

Returns the specified key's available encoded bytes, or null if not available.

Some KeyStore implementations - like Hardware Security Modules, PKCS11 key stores, and later versions of Android - will not allow applications or libraries to obtain a key's encoded bytes. In these cases, this method will return null.

Parameters:

key - the key to inspect

Returns:

the specified key's available encoded bytes, or null if not available.

isGenericSecret

public static boolean isGenericSecret(Key key)

findBitLength

public static int findBitLength(Key key)

Returns the specified key's key length (in bits) if possible, or -1 if unable to determine the length.

Parameters:

key - the key to inspect

Returns:

the specified key's key length in bits, or -1 if unable to determine length.

getEncoded

public static byte[] getEncoded(Key key)

toString

public static String toString(Key key)