com.authlete.mdoc.MobileSecurityObject 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.mdoc;


import java.util.List;
import com.authlete.cbor.CBORPair;
import com.authlete.cbor.CBORPairList;
import com.authlete.cbor.CBORPairsBuilder;
import com.authlete.cbor.CBORString;


/**
 * The {@code MobileSecurityObject} structure.
 *
 * 
 * For details, see ISO/IEC 18013-5:2021, 9.1.2.4 Signing method and structure for MSO.
 * 
 *
 * Definition
 *
 *  * MobileSecurityObject = {
 *     "version" : tstr,                ; Version of the MobileSecurityObject
 *     "digestAlgorithm" : tstr,        ; Message digest algorithm used
 *     "valueDigests" : {@link ValueDigests},   ; Digests of all data elements per namespace
 *     "deviceKeyInfo" : {@link DeviceKeyInfo},
 *     "docType" : tstr,                ; docType as used in Documents
 *     "validityInfo" : {@link ValidityInfo}
 * }
 * 
 *
 * @since 1.5
 *
 * @see ISO/IEC 18013-5:2021
 *
 * @see MobileSecurityObjectBytes
 */
public class MobileSecurityObject extends CBORPairList
{
    private static final String DEFAULT_VERSION          = "1.0";
    private static final String DEFAULT_DIGEST_ALGORITHM = "SHA-256";

    private static final CBORString LABEL_VERSION          = new CBORString("version");
    private static final CBORString LABEL_DIGEST_ALGORITHM = new CBORString("digestAlgorithm");
    private static final CBORString LABEL_VALUE_DIGESTS    = new CBORString("valueDigests");
    private static final CBORString LABEL_DEVICE_KEY_INFO  = new CBORString("deviceKeyInfo");
    private static final CBORString LABEL_DOC_TYPE         = new CBORString("docType");
    private static final CBORString LABEL_VALIDITY_INFO    = new CBORString("validityInfo");


    /**
     * A constructor with the default version and the default digest algorithm.
     * This constructor is an alias of {@link #MobileSecurityObject(String,
     * String, ValueDigests, DeviceKeyInfo, String, ValidityInfo)
     * MobileSecurityObject}{@code ("1.0", "SHA-256", valueDigests,
     * deviceKeyInfo, docType, validityInfo)}.
     */
    public MobileSecurityObject(
            ValueDigests valueDigests, DeviceKeyInfo deviceKeyInfo,
            String docType, ValidityInfo validityInfo)
    {
        this(DEFAULT_VERSION, DEFAULT_DIGEST_ALGORITHM,
                valueDigests, deviceKeyInfo, docType, validityInfo);
    }


    public MobileSecurityObject(
            String version, String digestAlgorithm,
            ValueDigests valueDigests, DeviceKeyInfo deviceKeyInfo,
            String docType, ValidityInfo validityInfo)
    {
        super(createList(
                version, digestAlgorithm, valueDigests,
                deviceKeyInfo, docType, validityInfo));
    }


    private static List createList(
            String version, String digestAlgorithm,
            ValueDigests valueDigests, DeviceKeyInfo deviceKeyInfo,
            String docType, ValidityInfo validityInfo)
    {
        return new CBORPairsBuilder()
                .addUnlessNull(LABEL_VERSION,          version)
                .addUnlessNull(LABEL_DIGEST_ALGORITHM, digestAlgorithm)
                .addUnlessNull(LABEL_VALUE_DIGESTS,    valueDigests)
                .addUnlessNull(LABEL_DEVICE_KEY_INFO,  deviceKeyInfo)
                .addUnlessNull(LABEL_DOC_TYPE,         docType)
                .addUnlessNull(LABEL_VALIDITY_INFO,    validityInfo)
                .build();
    }
}