• Home
• com.authlete
• cbor
• 1.19
• source code
• COSEKeyBuilder.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

com.authlete.cose.COSEKeyBuilder Maven / Gradle / Ivy

/*
 * Copyright (C) 2023 Authlete, Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.authlete.cose;


import java.nio.charset.StandardCharsets;
import java.util.Base64;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
import com.authlete.cbor.CBORPair;
import com.authlete.cbor.CBORPairList;
import com.authlete.cbor.CBORizer;
import com.authlete.cose.constants.COSEEllipticCurves;
import com.authlete.cose.constants.COSEKeyCommonParameters;
import com.authlete.cose.constants.COSEKeyTypeParameters;
import com.authlete.cose.constants.COSEKeyTypes;


/**
 * A utility to build an instance of {@link COSEKey} or its subclass
 * (e.g. {@link COSEOKPKey} and {@link COSEEC2Key}).
 *
 * @since 1.1
 *
 * @see RFC 9052, 7. Key Objects
 *
 * @see IANA: COSE Key Common Parameters
 *
 * @see IANA: COSE Key Type Parameters
 *
 * @see IANA: COSE Key Types
 *
 * @see IANA: COSE Elliptic Curves
 */
public class COSEKeyBuilder
{
    /**
     * Decoder for base64url.
     */
    private static final Base64.Decoder BASE64URL_DECODER = Base64.getUrlDecoder();


    private final Map map = new LinkedHashMap<>();


    /**
     * Decode the given string in the base64url format into a byte array.
     *
     * @param input
     *         A string in the base64url format.
     *
     * @return
     *         A decoded byte array.
     */
    private static byte[] decodeBase64Url(String input)
    {
        return BASE64URL_DECODER.decode(input);
    }


    /**
     * Set a parameter.
     *
     * @param key
     *         The key of the parameter.
     *
     * @param value
     *         The value of the parameter.
     *
     * @return
     *         {@code this} object.
     */
    public COSEKeyBuilder put(Object key, Object value)
    {
        map.put(key, value);

        return this;
    }


    /**
     * Set the "kty (1)" parameter.
     *
     * @param kty
     *         The key type.
     *
     * @return
     *         {@code this} object.
     *
     * @see IANA: COSE Key Types
     */
    public COSEKeyBuilder kty(String kty)
    {
        return put(COSEKeyCommonParameters.KTY, kty);
    }


    /**
     * Set the "kty (1)" parameter.
     *
     * @param kty
     *         The key type.
     *
     * @return
     *         {@code this} object.
     *
     * @see IANA: COSE Key Types
     */
    public COSEKeyBuilder kty(int kty)
    {
        return put(COSEKeyCommonParameters.KTY, kty);
    }


    /**
     * Set "OKP (1)" to the "kty (1)" parameter.
     *
     * @return
     *         {@code this} object.
     */
    public COSEKeyBuilder ktyOKP()
    {
        return kty(COSEKeyTypes.OKP);
    }


    /**
     * Set "EC2 (2)" to the "kty (1)" parameter.
     *
     * @return
     *         {@code this} object.
     */
    public COSEKeyBuilder ktyEC2()
    {
        return kty(COSEKeyTypes.EC2);
    }


    /**
     * Set "RSA (3)" to the "kty (1)" parameter.
     *
     * @return
     *         {@code this} object.
     */
    public COSEKeyBuilder ktyRSA()
    {
        return kty(COSEKeyTypes.RSA);
    }


    /**
     * Set "Symmetric (4)" to the "kty (1)" parameter.
     *
     * @return
     *         {@code this} object.
     */
    public COSEKeyBuilder ktySymmetric()
    {
        return kty(COSEKeyTypes.SYMMETRIC);
    }


    /**
     * Set "HSS-LMS (5)" to the "kty (1)" parameter.
     *
     * @return
     *         {@code this} object.
     */
    public COSEKeyBuilder ktyHSSLMS()
    {
        return kty(COSEKeyTypes.HSS_LMS);
    }


    /**
     * Set "WalnutDSA (6)" to the "kty (1)" parameter.
     *
     * @return
     *         {@code this} object.
     */
    public COSEKeyBuilder ktyWalnutDSA()
    {
        return kty(COSEKeyTypes.WALNUT_DSA);
    }


    /**
     * Set the "kid (2)" parameter.
     *
     * @param kid
     *         The key ID.
     *
     * @return
     *         {@code this} object.
     */
    public COSEKeyBuilder kid(byte[] kid)
    {
        return put(COSEKeyCommonParameters.KID, kid);
    }


    /**
     * Set the "kid (2)" parameter.
     *
     * @param kid
     *         The key ID. Its UTF-8 byte sequence is used.
     *
     * @return
     *         {@code this} object.
     */
    public COSEKeyBuilder kid(String kid)
    {
        byte[] bytes = (kid != null) ? kid.getBytes(StandardCharsets.UTF_8): null;

        return kid(bytes);
    }


    /**
     * Set the "alg (3)" parameter.
     *
     * @param alg
     *         The algorithm.
     *
     * @return
     *         {@code this} object.
     *
     * @see IANA: COSE Algorithms
     */
    public COSEKeyBuilder alg(String alg)
    {
        return put(COSEKeyCommonParameters.ALG, alg);
    }


    /**
     * Set the "alg (3)" parameter.
     *
     * @param alg
     *         The algorithm.
     *
     * @return
     *         {@code this} object.
     *
     * @see IANA: COSE Algorithms
     */
    public COSEKeyBuilder alg(int alg)
    {
        return put(COSEKeyCommonParameters.ALG, alg);
    }


    /**
     * Set the "key_ops (4)" parameter.
     *
     * @param operations
     *         Key operations.
     *
     * @return
     *         {@code this} object.
     */
    public COSEKeyBuilder keyOps(List