org.jose4j.jwk.OctetKeyPairJsonWebKey Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of wildfly-elytron
WildFly Security SPIs
The newest version!
package org.jose4j.jwk;

import org.jose4j.base64url.Base64Url;
import org.jose4j.keys.EdDsaKeyUtil;
import org.jose4j.keys.OctetKeyPairUtil;
import org.jose4j.keys.XDHKeyUtil;
import org.jose4j.lang.ExceptionHelp;
import org.jose4j.lang.InvalidKeyException;
import org.jose4j.lang.JoseException;
import org.jose4j.lang.UncheckedJoseException;

import java.security.Key;
import java.security.PublicKey;
import java.security.interfaces.EdECKey;
import java.security.interfaces.XECKey;
import java.security.spec.NamedParameterSpec;
import java.util.Arrays;
import java.util.HashMap;
import java.util.HashSet;
import java.util.Map;
import java.util.Set;


public class OctetKeyPairJsonWebKey extends PublicJsonWebKey
{
    static final Set APPLICABLE_KEY_ALGORITHMS = new HashSet<>(Arrays.asList(
            EdDsaKeyUtil.ED448, EdDsaKeyUtil.ED25519, "EdDSA", XDHKeyUtil.X25519, XDHKeyUtil.X448, "XDH"));

    public static final String KEY_TYPE = "OKP";
    public static final String SUBTYPE_MEMBER_NAME = "crv";
    public static final String PUBLIC_KEY_MEMBER_NAME = "x";
    public static final String PRIVATE_KEY_MEMBER_NAME = "d";

    public static final String SUBTYPE_ED25519 = EdDsaKeyUtil.ED25519;
    public static final String SUBTYPE_ED448 = EdDsaKeyUtil.ED448;

    public static final String SUBTYPE_X25519 = XDHKeyUtil.X25519;
    public static final String SUBTYPE_X448 = XDHKeyUtil.X448;

    private final String subtype;

    public OctetKeyPairJsonWebKey(PublicKey publicKey)
    {
        super(publicKey);
        if (XDHKeyUtil.isXECPublicKey(publicKey))
        {
            XECKey xecKey = (XECKey) publicKey;
            subtype = ((NamedParameterSpec) (xecKey).getParams()).getName();
        }
        else if (EdDsaKeyUtil.isEdECPublicKey(publicKey))
        {
            EdECKey edECKey = (EdECKey) publicKey;
            subtype = edECKey.getParams().getName();
        }
        else
        {
            throw new UncheckedJoseException("Unable to determine OKP subtype from " + publicKey);
        }
    }

    public OctetKeyPairJsonWebKey(Map params) throws JoseException
    {
        this(params, null);
    }

    public OctetKeyPairJsonWebKey(Map params, String jcaProvider) throws JoseException
    {
        super(params, jcaProvider);

        subtype = getString(params, SUBTYPE_MEMBER_NAME, true);
        try
        {
            OctetKeyPairUtil keyUtil = subtypeKeyUtil();
            if (keyUtil == null)
            {
                throw new InvalidKeyException("\"" + subtype + "\" is an unknown or unsupported subtype value for the \"crv\" parameter.");
            }

            String encodedX = getString(params, PUBLIC_KEY_MEMBER_NAME, true);
            byte[] x = Base64Url.decode(encodedX);
            key = keyUtil.publicKey(x, subtype);

            checkForBareKeyCertMismatch();

            if (params.containsKey(PRIVATE_KEY_MEMBER_NAME))
            {
                String encodedD = getString(params, PRIVATE_KEY_MEMBER_NAME, false);
                byte[] d = Base64Url.decode(encodedD);
                privateKey = keyUtil.privateKey(d, subtype);
            }
        }
        catch (NoClassDefFoundError ncd)
        {
            throw new JoseException("Unable to instantiate key for OKP JWK with " +subtype+ ". " + ExceptionHelp.toStringWithCauses(ncd));
        }

        removeFromOtherParams(SUBTYPE_MEMBER_NAME, PUBLIC_KEY_MEMBER_NAME, PRIVATE_KEY_MEMBER_NAME);
    }

    static boolean isApplicable(Key key)
    {
        return APPLICABLE_KEY_ALGORITHMS.contains(key.getAlgorithm());
    }

    @Override
    public String getKeyType()
    {
        return KEY_TYPE;
    }

    public String getSubtype()
    {
        return subtype;
    }

    @Override
    protected String produceThumbprintHashInput()
    {
        String template = "{\"crv\":\"%s\",\"kty\":\"OKP\",\"x\":\"%s\"}";
        HashMap params = new HashMap<>();
        fillPublicTypeSpecificParams(params);
        Object crv = params.get(SUBTYPE_MEMBER_NAME);
        Object x = params.get(PUBLIC_KEY_MEMBER_NAME);
        return String.format(template, crv, x);
    }

    @Override
    protected void fillPublicTypeSpecificParams(Map params)
    {
        OctetKeyPairUtil ku = subtypeKeyUtil();
        byte[] publicKeyBytes = ku.rawPublicKey(this.key);
        params.put(SUBTYPE_MEMBER_NAME, subtype);
        params.put(PUBLIC_KEY_MEMBER_NAME, Base64Url.encode(publicKeyBytes));
    }

    @Override
    protected void fillPrivateTypeSpecificParams(Map params)
    {
        if (privateKey != null)
        {
            OctetKeyPairUtil ku = subtypeKeyUtil();
            byte[] privateKeyBytes = ku.rawPrivateKey(privateKey);
            params.put(PRIVATE_KEY_MEMBER_NAME, Base64Url.encode(privateKeyBytes));
        }
    }

    OctetKeyPairUtil subtypeKeyUtil()
    {
        return OctetKeyPairUtil.getOctetKeyPairUtil(subtype, jcaProvider, null);
    }
}