com.yubico.webauthn.data.COSEAlgorithmIdentifier Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of webauthn-server-core Show documentation
Yubico WebAuthn server core API
The newest version!
// Copyright (c) 2018, Yubico AB
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are met:
//
// 1. Redistributions of source code must retain the above copyright notice, this
//    list of conditions and the following disclaimer.
//
// 2. Redistributions in binary form must reproduce the above copyright notice,
//    this list of conditions and the following disclaimer in the documentation
//    and/or other materials provided with the distribution.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
// DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
// FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
// DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
// SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
// CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
// OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

package com.yubico.webauthn.data;

import com.fasterxml.jackson.annotation.JsonCreator;
import com.fasterxml.jackson.annotation.JsonValue;
import com.upokecenter.cbor.CBORException;
import com.upokecenter.cbor.CBORObject;
import java.util.Optional;
import java.util.stream.Stream;
import lombok.Getter;
import lombok.NonNull;

/**
 * A number identifying a cryptographic algorithm. The algorithm identifiers SHOULD be values
 * registered in the IANA COSE Algorithms registry, for instance, -7 for "ES256" and -257 for
 * "RS256".
 *
 * @see §5.10.5.
 *     Cryptographic Algorithm Identifier (typedef COSEAlgorithmIdentifier)
 */
public enum COSEAlgorithmIdentifier {
  EdDSA(-8),
  ES256(-7),
  ES384(-35),
  ES512(-36),
  RS256(-257),
  RS384(-258),
  RS512(-259),
  RS1(-65535);

  @JsonValue @Getter private final long id;

  COSEAlgorithmIdentifier(long id) {
    this.id = id;
  }

  /**
   * Attempt to parse an integer as a {@link COSEAlgorithmIdentifier}.
   *
   * @param id an integer equal to the {@link #getId() id} of a constant in {@link
   *     COSEAlgorithmIdentifier}
   * @return The {@link COSEAlgorithmIdentifier} instance whose {@link #getId() id} equals id
   *     , if any.
   * @see §5.8.5.
   *     Cryptographic Algorithm Identifier (typedef COSEAlgorithmIdentifier)
   */
  public static Optional fromId(long id) {
    return Stream.of(values()).filter(v -> v.id == id).findAny();
  }

  /**
   * Read the {@link COSEAlgorithmIdentifier} from a public key in COSE_Key format.
   *
   * @param publicKeyCose a public key in COSE_Key format.
   * @return The alg of the publicKeyCose parsed as a {@link
   *     COSEAlgorithmIdentifier}, if possible. Returns empty if the {@link COSEAlgorithmIdentifier}
   *     enum has no constant matching the alg value.
   * @throws IllegalArgumentException if publicKeyCose is not a well-formed COSE_Key.
   */
  public static Optional fromPublicKey(@NonNull ByteArray publicKeyCose) {
    final CBORObject ALG = CBORObject.FromObject(3);
    final int alg;
    try {
      CBORObject cose = CBORObject.DecodeFromBytes(publicKeyCose.getBytes());
      if (!cose.ContainsKey(ALG)) {
        throw new IllegalArgumentException(
            "Public key does not contain an \"alg\"(3) value: " + publicKeyCose);
      }
      CBORObject algCbor = cose.get(ALG);
      if (!(algCbor.isNumber() && algCbor.AsNumber().IsInteger())) {
        throw new IllegalArgumentException(
            "Public key has non-integer \"alg\"(3) value: " + publicKeyCose);
      }
      alg = algCbor.AsInt32();
    } catch (CBORException e) {
      throw new IllegalArgumentException("Failed to parse public key", e);
    }
    return fromId(alg);
  }

  @JsonCreator
  private static COSEAlgorithmIdentifier fromJson(long id) {
    return fromId(id)
        .orElseThrow(
            () -> new IllegalArgumentException("Unknown COSE algorithm identifier: " + id));
  }
}