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

Go to download
Show more of this group Show more artifacts with this name
Show all versions of cbor Show documentation
A Java library for CBOR, COSE, CWT and mdoc.
The newest version!
/*
 * 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.util.List;
import com.authlete.cbor.CBORByteArray;
import com.authlete.cbor.CBORItem;
import com.authlete.cbor.CBORNull;
import com.authlete.cbor.CBORizer;


/**
 * COSE_Mac0
 *
 * 
 * {@code COSE_Mac0} is defined in 6.2. MACed
 * Message with Implicit Key of RFC 9052 as follows.
 * 
 *
 *  * COSE_Mac0 = [
 *     Headers,
 *     payload : bstr / nil,
 *     tag : bstr,
 * ]
 * 
 *
 * @since 1.1
 *
 * @see RFC 9052, 6.2. MACed Message with Implicit Key
 */
public class COSEMac0 extends COSEMessage
{
    /**
     * A constructor with a protected header, an unprotected header, a
     * payload, and a tag.
     *
     * @param protectedHeader
     *         A protected header. Must not be null.
     *
     * @param unprotectedHeader
     *         An unprotected header. Must not be null.
     *
     * @param payload
     *         A payload. Must be either {@link CBORByteArray} or
     *         {@link CBORNull}.
     *
     * @param tag
     *         A tag. Must not be null.
     */
    public COSEMac0(
            COSEProtectedHeader protectedHeader,
            COSEUnprotectedHeader unprotectedHeader,
            CBORItem payload,
            CBORByteArray tag)
    {
        super(COSEMessageType.COSE_MAC0,
                protectedHeader, unprotectedHeader, payload, tag);

        validateTag(tag);
    }


    private static void validateTag(CBORByteArray tag)
    {
        if (tag == null)
        {
            throw new IllegalArgumentException(
                    "A tag given to COSEMac0's constructor must not be null.");
        }
    }


    /**
     * Get the payload.
     *
     * 
     * The type of the value is {@link CBORByteArray} or {@link CBORNull}.
     * 
     *
     * @return
     *         The payload.
     */
    public CBORItem getPayload()
    {
        return getItems().get(2);
    }


    /**
     * Get the tag.
     *
     * @return
     *         The tag.
     */
    public CBORByteArray getTag()
    {
        return (CBORByteArray)getItems().get(3);
    }


    /**
     * Build a {@code COSEMac0} instance from the given CBOR data item.
     * The data item must be a CBOR array.
     *
     * @param item
     *         A CBOR data item that represents {@code COSE_Mac0}.
     *
     * @return
     *         A {@code COSEMac0} instance built from the given CBOR data item.
     *
     * @throws COSEException
     */
    public static COSEMac0 build(CBORItem item) throws COSEException
    {
        // Build the protected header, the unprotected header and the content.
        List common = COSEObject.buildCommon(item, "COSE_Mac0", 4);

        // The fourth element of COSE_Mac0, which is a tag.
        CBORItem fourth = common.get(3);

        // If the fourth element is not a byte string.
        if (!(fourth instanceof CBORByteArray))
        {
            throw new COSEException(
                    "The fourth element (tag) of COSE_Mac0 must be a byte string.");
        }

        try
        {
            return new COSEMac0(
                    (COSEProtectedHeader)common.get(0),
                    (COSEUnprotectedHeader)common.get(1),
                    common.get(2),
                    (CBORByteArray)fourth);
        }
        catch (Exception cause)
        {
            throw new COSEException(cause.getMessage(), cause);
        }
    }


    /**
     * Build a {@code COSEMac0} instance from the given object list.
     *
     * @param list
     *         A object list that represents {@code COSE_Mac0}.
     *
     * @return
     *         A {@code COSEMac0} instance built from the given object list.
     *
     * @throws COSEException
     */
    public static COSEMac0 build(List