com.authlete.cose.constants.COSEKeyCommonParameters 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.constants;


/**
 * COSE Key Common Parameters
 *
 * 
 * 
 *
 *   
 *     
 *     
 *     
 *     
 *   
 *
 *   
 *     
 *     
 *     
 *     
 *   
 *
 *   
 *     
 *     
 *     
 *     
 *   
 *
 *   
 *     
 *     
 *     
 *     
 *   
 *
 *   
 *     
 *     
 *     
 *     
 *   
 *
 *   
 *     
 *     
 *     
 *     
 *   
 *
 * Name Label CBOR Type Description
{@link #KTY kty} 1 tstr / int Identification of the key type
{@link #KID kid} 2 bstr Key identification value - match to kid in message
{@link #ALG alg} 3 tstr / int Key usage restriction to this algorithm
{@link #KEY_OPS key_ops} 4 [+ (tstr/int)] Restrict set of permissible operations
{@link #BASE_IV Base IV} 5 bstr Base IV to be XORed with Partial IVs
 * 
 *
 * @since 1.1
 *
 * @see IANA: COSE Key Common Parameters
 */
public final class COSEKeyCommonParameters
{
    /** kty (1) */
    public static final int KTY = 1;

    /** kid (2) */
    public static final int KID = 2;

    /** alg (3) */
    public static final int ALG = 3;

    /** key_ops (4) */
    public static final int KEY_OPS = 4;

    /** Base IV (5) */
    public static final int BASE_IV = 5;


    private COSEKeyCommonParameters()
    {
    }
}

Name	Label	CBOR Type	Description
{@link #KTY kty}	1	tstr / int	Identification of the key type
{@link #KID kid}	2	bstr	Key identification value - match to kid in message
{@link #ALG alg}	3	tstr / int	Key usage restriction to this algorithm
{@link #KEY_OPS key_ops}	4	[+ (tstr/int)]	Restrict set of permissible operations
{@link #BASE_IV Base IV}	5	bstr	Base IV to be XORed with Partial IVs