UA-.NETStandard/Stack/Opc.Ua.Security.Certificates/Common/Oids.cs

/* ========================================================================
 * Copyright (c) 2005-2025 The OPC Foundation, Inc. All rights reserved.
 *
 * OPC Foundation MIT License 1.00
 *
 * Permission is hereby granted, free of charge, to any person
 * obtaining a copy of this software and associated documentation
 * files (the "Software"), to deal in the Software without
 * restriction, including without limitation the rights to use,
 * copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the
 * Software is furnished to do so, subject to the following
 * conditions:
 *
 * The above copyright notice and this permission notice shall be
 * included in all copies or substantial portions of the Software.
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
 * OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
 * HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
 * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
 * OTHER DEALINGS IN THE SOFTWARE.
 *
 * The complete license agreement can be found here:
 * http://opcfoundation.org/License/MIT/1.00/
 * ======================================================================*/

using System.Security.Cryptography;

namespace Opc.Ua.Security.Certificates
{
    /// <summary>
    /// Oid constants defined for ASN encoding/decoding.
    /// </summary>
    public static class Oids
    {
        /// <summary>
        /// The Oid string of the Digital Signature Algorithm (DSA) subject public key.
        /// </summary>
        public const string Dsa = "1.2.840.10040.4.1";

        /// <summary>
        /// The Oid string for the RSA encryption scheme with PKCS#1.
        /// </summary>
        public const string Rsa = "1.2.840.113549.1.1.1";

        /// <summary>
        /// The Oid string for the RSA encryption scheme with OAEP.
        /// </summary>
        public const string RsaOaep = "1.2.840.113549.1.1.7";

        /// <summary>
        /// The Oid string for the RSA encryption scheme with PSS.
        /// </summary>
        public const string RsaPss = "1.2.840.113549.1.1.10";

        /// <summary>
        /// The Oid string for RSA signature, PKCS#1 padding with SHA1 hash.
        /// </summary>
        public const string RsaPkcs1Sha1 = "1.2.840.113549.1.1.5";

        /// <summary>
        /// The Oid string for RSA signature, PKCS#1 padding with SHA256 hash.
        /// </summary>
        public const string RsaPkcs1Sha256 = "1.2.840.113549.1.1.11";

        /// <summary>
        /// The Oid string for RSA signature, PKCS#1 padding with SHA384 hash.
        /// </summary>
        public const string RsaPkcs1Sha384 = "1.2.840.113549.1.1.12";

        /// <summary>
        /// The Oid string for RSA signature, PKCS#1 padding with SHA512 hash.
        /// </summary>
        public const string RsaPkcs1Sha512 = "1.2.840.113549.1.1.13";

        /// <summary>
        /// The Oid string for a EC public key.
        /// </summary>
        public const string ECPublicKey = "1.2.840.10045.2.1";

        /// <summary>
        /// The Oid string for ECDsa signature with SHA1 hash.
        /// </summary>
        public const string ECDsaWithSha1 = "1.2.840.10045.4.1";

        /// <summary>
        /// The Oid string for ECDsa signature with SHA256 hash.
        /// </summary>
        public const string ECDsaWithSha256 = "1.2.840.10045.4.3.2";

        /// <summary>
        /// The Oid string for ECDsa signature with SHA384 hash.
        /// </summary>
        public const string ECDsaWithSha384 = "1.2.840.10045.4.3.3";

        /// <summary>
        /// The Oid string for ECDsa signature with SHA512 hash.
        /// </summary>
        public const string ECDsaWithSha512 = "1.2.840.10045.4.3.4";

        /// <summary>
        /// The Oid string for the CRL extension of a CRL Number.
        /// </summary>
        public const string CrlNumber = "2.5.29.20";

        /// <summary>
        /// The Oid string for the CRL extension of a CRL Reason Code.
        /// </summary>
        public const string CrlReasonCode = "2.5.29.21";

        /// <summary>
        /// The Oid string for Transport Layer Security(TLS) World Wide Web(WWW)
        /// server authentication.
        /// </summary>
        public const string ServerAuthentication = "1.3.6.1.5.5.7.3.1";

        /// <summary>
        /// The Oid string for Transport Layer Security(TLS) World Wide Web(WWW)
        /// client authentication.
        /// </summary>
        public const string ClientAuthentication = "1.3.6.1.5.5.7.3.2";

        /// <summary>
        /// The Oid string for Authority Information access.
        /// </summary>
        public const string AuthorityInfoAccess = "1.3.6.1.5.5.7.1.1";

        /// <summary>
        /// The Oid string for Online Certificate Status Protocol.
        /// </summary>
        public const string OnlineCertificateStatusProtocol = "1.3.6.1.5.5.7.48.1";

        /// <summary>
        /// The Oid string for Certificate Authority Issuer.
        /// </summary>
        public const string CertificateAuthorityIssuers = "1.3.6.1.5.5.7.48.2";

        /// <summary>
        /// The Oid string for CRL Distribution Point.
        /// </summary>
        public const string CRLDistributionPoint = "2.5.29.31";

        /// <summary>
        /// Get the RSA oid for a hash algorithm signature.
        /// </summary>
        /// <param name="hashAlgorithm">The hash algorithm name.</param>
        /// <exception cref="CryptographicException"></exception>
        public static string GetRSAOid(HashAlgorithmName hashAlgorithm)
        {
            if (hashAlgorithm == HashAlgorithmName.SHA1)
            {
                return RsaPkcs1Sha1;
            }
            else if (hashAlgorithm == HashAlgorithmName.SHA256)
            {
                return RsaPkcs1Sha256;
            }
            else if (hashAlgorithm == HashAlgorithmName.SHA384)
            {
                return RsaPkcs1Sha384;
            }
            else if (hashAlgorithm == HashAlgorithmName.SHA512)
            {
                return RsaPkcs1Sha512;
            }
            else
            {
                throw new CryptographicException(
                    $"Signing RSA with hash {hashAlgorithm.Name} is not supported. ");
            }
        }

        /// <summary>
        /// Get the ECDsa oid for a hash algorithm signature.
        /// </summary>
        /// <param name="hashAlgorithm">The hash algorithm name.</param>
        /// <exception cref="CryptographicException"></exception>
        public static string GetECDsaOid(HashAlgorithmName hashAlgorithm)
        {
            if (hashAlgorithm == HashAlgorithmName.SHA1)
            {
                return ECDsaWithSha1;
            }
            else if (hashAlgorithm == HashAlgorithmName.SHA256)
            {
                return ECDsaWithSha256;
            }
            else if (hashAlgorithm == HashAlgorithmName.SHA384)
            {
                return ECDsaWithSha384;
            }
            else if (hashAlgorithm == HashAlgorithmName.SHA512)
            {
                return ECDsaWithSha512;
            }
            else
            {
                throw new CryptographicException(
                    $"Signing ECDsa with hash {hashAlgorithm.Name} is not supported. ");
            }
        }

        /// <summary>
        /// Get the hash algorithm used to sign a certificate.
        /// </summary>
        /// <param name="oid">The signature algorithm oid.</param>
        /// <exception cref="CryptographicException"></exception>
        public static HashAlgorithmName GetHashAlgorithmName(string oid)
        {
            return oid switch
            {
                ECDsaWithSha1 or RsaPkcs1Sha1 => HashAlgorithmName.SHA1,
                ECDsaWithSha256 or RsaPkcs1Sha256 => HashAlgorithmName.SHA256,
                ECDsaWithSha384 or RsaPkcs1Sha384 => HashAlgorithmName.SHA384,
                ECDsaWithSha512 or RsaPkcs1Sha512 => HashAlgorithmName.SHA512,
                _ => throw new CryptographicException($"Hash algorithm {oid} is not supported. ")
            };
        }
    }
}