File: Signing\Specifications\SigningSpecifications.cs
Web Access
Project: src\src\nuget-client\src\NuGet.Core\NuGet.Packaging\NuGet.Packaging.csproj (NuGet.Packaging)
// Copyright (c) .NET Foundation. All rights reserved.
// Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.

using System.Text;
using NuGet.Common;

namespace NuGet.Packaging.Signing
{
    /// <summary>
    /// Abstract class representing which paths may be used for signing in a package.
    /// </summary>
    public abstract class SigningSpecifications
    {
        /// <summary>
        /// v1.0.0 signing settings.
        /// </summary>
        public static readonly SigningSpecificationsV1 V1 = new SigningSpecificationsV1();

        /// <summary>
        /// Gets the signature format version.
        /// </summary>
        public abstract string Version { get; }

        /// <summary>
        /// Returns the path for the signature file.
        /// </summary>
        public abstract string SignaturePath { get; }

        /// <summary>
        /// Returns the set of allowed hash algorithms.
        /// </summary>
        public abstract HashAlgorithmName[] AllowedHashAlgorithms { get; }

        /// <summary>
        /// Returns the set of allowed hash algorithm Oids.
        /// </summary>
        public abstract string[] AllowedHashAlgorithmOids { get; }

        /// <summary>
        /// Returns the set of allowed signature algorithms.
        /// </summary>
        public abstract SignatureAlgorithmName[] AllowedSignatureAlgorithms { get; }

        /// <summary>
        /// Returns the set of allowed signature algorithm Oids.
        /// </summary>
        public abstract string[] AllowedSignatureAlgorithmOids { get; }

        /// <summary>
        /// Returns minumum length required for RSA public keys.
        /// </summary>
        public abstract int RSAPublicKeyMinLength { get; }

        /// <summary>
        /// Encoding used to generate the signature.
        /// </summary>
        public abstract Encoding Encoding { get; }

        /// <summary>
        /// Initialize a signing specification with a root folder.
        /// </summary>
        protected SigningSpecifications()
        {
        }
    }
}