Skip to content

Commit

Permalink
refactor: [breaking] remove obsolete Credentials constructors, making…
Browse files Browse the repository at this point in the history 
… it read-only.

It is advised to create Credentials from Configuration, using 'BuildCredentials()'
  • Loading branch information
@Tr00d
Tr00d committed Mar 15, 2024
1 parent 8d42b09 commit e701f21
Showing 1 changed file with 136 additions and 173 deletions.
309 changes: 136 additions & 173 deletions Vonage/Request/Credentials.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,191 +6,154 @@
using Vonage.Common.Monads;
using Vonage.Cryptography;

namespace Vonage.Request
namespace Vonage.Request;

/// <summary>
/// Represents credentials for Vonage APIs.
/// </summary>
public class Credentials
{
internal Credentials()
{
}

/// <summary>
/// Vonage API Key (from your account dashboard)
/// </summary>
public string ApiKey { get; internal init; }

/// <summary>
/// Vonage API Secret (from your account dashboard)
/// </summary>
public string ApiSecret { get; internal init; }

/// <summary>
/// Application ID (GUID)
/// </summary>
public string ApplicationId { get; internal init; }

/// <summary>
/// Application private key contents
/// This is the actual key file contents and NOT a path to the key file!
/// </summary>
public string ApplicationKey { get; internal init; }

/// <summary>
/// (Optional) App useragent value to pass with every request
/// </summary>
public string AppUserAgent { get; internal init; }

/// <summary>
/// Method to be used for signing SMS Messages
/// </summary>
public SmsSignatureGenerator.Method Method { get; internal init; }

/// <summary>
/// Signature Secret (from API settings section of your account settings)
/// </summary>
public string SecuritySecret { get; internal set; }

/// <summary>
/// Builds credentials from ApiKey and ApiSecret.
/// </summary>
/// <param name="apiKey">The api key.</param>
/// <param name="apiSecret">The api secret.</param>
/// <returns>The credentials.</returns>
public static Credentials FromApiKeyAndSecret(string apiKey, string apiSecret) =>
new Credentials {ApiKey = apiKey, ApiSecret = apiSecret};

/// <summary>
/// Represents credentials for Vonage APIs.
/// Builds Credentials from ApiKey, SignatureSecret and Method.
/// </summary>
public class Credentials
/// <param name="apiKey">The api key.</param>
/// <param name="signatureSecret">The signature secret.</param>
/// <param name="signatureMethod">The signature method.</param>
/// <returns>The credentials.</returns>
public static Credentials FromApiKeySignatureSecretAndMethod(string apiKey, string signatureSecret,
SmsSignatureGenerator.Method signatureMethod) =>
new Credentials {ApiKey = apiKey, SecuritySecret = signatureSecret, Method = signatureMethod};

/// <summary>
/// Builds Credentials from ApplicationId and PrivateKey.
/// </summary>
/// <param name="appId">The application id.</param>
/// <param name="privateKey">The private key.</param>
/// <returns>The credentials.</returns>
public static Credentials FromAppIdAndPrivateKey(string appId, string privateKey) =>
new Credentials {ApplicationId = appId, ApplicationKey = privateKey};

/// <summary>
/// Builds Credentials from ApplicationId and PrivateKey file.
/// </summary>
/// <param name="appId">Your Vonage Application ID</param>
/// <param name="privateKeyPath">path to your private Key file</param>
/// <exception cref="System.UnauthorizedAccessException">Thrown if app doesn't have required permission to key file</exception>
/// <exception cref="System.ArgumentException">
/// privateKeyPath is a zero length string, contains only white space or
/// contains one or more invalid characters
/// </exception>
/// <exception cref="System.ArgumentNullException">privateKeyPath is null</exception>
/// <exception cref="System.IO.PathTooLongException">
/// The specified path, filename, or both exceed the system-defined max
/// length
/// </exception>
/// <exception cref="System.IO.DirectoryNotFoundException">
/// The specified path is invalid, (for example, it is on an
/// unmapped drive).
/// </exception>
/// <exception cref="System.IO.FileNotFoundException">The file specified in path was not found.</exception>
/// <exception cref="System.NotSupportedException">path is in an invalid format.</exception>
/// <returns>CredentialsObject</returns>
public static Credentials FromAppIdAndPrivateKeyPath(string appId, string privateKeyPath)
{
/// <summary>
/// Vonage API Key (from your account dashboard)
/// </summary>
public string ApiKey { get; set; }

/// <summary>
/// Vonage API Secret (from your account dashboard)
/// </summary>
public string ApiSecret { get; set; }

/// <summary>
/// Application ID (GUID)
/// </summary>
public string ApplicationId { get; set; }

/// <summary>
/// Application private key contents
/// This is the actual key file contents and NOT a path to the key file!
/// </summary>
public string ApplicationKey { get; set; }

/// <summary>
/// (Optional) App useragent value to pass with every request
/// </summary>
public string AppUserAgent { get; set; }

/// <summary>
/// Method to be used for signing SMS Messages
/// </summary>
public SmsSignatureGenerator.Method Method { get; set; }

/// <summary>
/// Signature Secret (from API settings section of your account settings)
/// </summary>
public string SecuritySecret { get; set; }

/// <summary>
/// Obsolete constructor for Credentials.
/// </summary>
[Obsolete(
"Factory methods should be favoured over constructors. Public constructors will be removed on next major release.")]
public Credentials()
{
}
using var reader = File.OpenText(privateKeyPath);
var privateKey = reader.ReadToEnd();
return new Credentials {ApplicationId = appId, ApplicationKey = privateKey};
}

/// <summary>
/// Obsolete constructor for Credentials.
/// </summary>
/// <param name="vonageApiKey">The api key.</param>
/// <param name="vonageApiSecret">The api secret.</param>
[Obsolete(
"Factory methods should be favoured over constructors. Public constructors will be removed on next major release.")]
public Credentials(string vonageApiKey, string vonageApiSecret)
{
ApiKey = vonageApiKey;
ApiSecret = vonageApiSecret;
}
/// <summary>
/// Provides the preferred authentication based on authentication type.
/// </summary>
/// <returns>The authentication header if it matches any criteria. A AuthenticationFailure otherwise.</returns>
public Result<AuthenticationHeaderValue> GetAuthenticationHeader() =>
this.GetPreferredAuthenticationType().Bind(this.GetPreferredAuthenticationHeader);

/// <summary>
/// Obsolete constructor for Credentials.
/// </summary>
/// <param name="vonageApiKey">The api key.</param>
/// <param name="vonageApiSecret">The api secret.</param>
/// <param name="vonageApplicationId">The application id.</param>
/// <param name="vonageApplicationPrivateKey">The private key.</param>
[Obsolete(
"Factory methods should be favoured over constructors. Public constructors will be removed on next major release.")]
public Credentials(string vonageApiKey, string vonageApiSecret, string vonageApplicationId,
string vonageApplicationPrivateKey)
/// <summary>
/// Provides the preferred authentication type.
/// </summary>
/// <returns>The authentication type if it matches any criteria. A AuthenticationFailure otherwise.</returns>
/// <remarks>
/// Bearer will always be preferred over Basic if possible.
/// </remarks>
public Result<AuthType> GetPreferredAuthenticationType()
{
if (!string.IsNullOrWhiteSpace(this.ApplicationId) && !string.IsNullOrWhiteSpace(this.ApplicationKey))
{
ApiKey = vonageApiKey;
ApiSecret = vonageApiSecret;
ApplicationId = vonageApplicationId;
ApplicationKey = vonageApplicationPrivateKey;
return AuthType.Bearer;
}

/// <summary>
/// Builds credentials from ApiKey and ApiSecret.
/// </summary>
/// <param name="apiKey">The api key.</param>
/// <param name="apiSecret">The api secret.</param>
/// <returns>The credentials.</returns>
public static Credentials FromApiKeyAndSecret(string apiKey, string apiSecret) =>
new() {ApiKey = apiKey, ApiSecret = apiSecret};

/// <summary>
/// Builds Credentials from ApiKey, SignatureSecret and Method.
/// </summary>
/// <param name="apiKey">The api key.</param>
/// <param name="signatureSecret">The signature secret.</param>
/// <param name="signatureMethod">The signature method.</param>
/// <returns>The credentials.</returns>
public static Credentials FromApiKeySignatureSecretAndMethod(string apiKey, string signatureSecret,
SmsSignatureGenerator.Method signatureMethod) =>
new() {ApiKey = apiKey, SecuritySecret = signatureSecret, Method = signatureMethod};

/// <summary>
/// Builds Credentials from ApplicationId and PrivateKey.
/// </summary>
/// <param name="appId">The application id.</param>
/// <param name="privateKey">The private key.</param>
/// <returns>The credentials.</returns>
public static Credentials FromAppIdAndPrivateKey(string appId, string privateKey) =>
new() {ApplicationId = appId, ApplicationKey = privateKey};

/// <summary>
/// Builds Credentials from ApplicationId and PrivateKey file.
/// </summary>
/// <param name="appId">Your Vonage Application ID</param>
/// <param name="privateKeyPath">path to your private Key file</param>
/// <exception cref="System.UnauthorizedAccessException">Thrown if app doesn't have required permission to key file</exception>
/// <exception cref="System.ArgumentException">
/// privateKeyPath is a zero length string, contains only white space or
/// contains one or more invalid characters
/// </exception>
/// <exception cref="System.ArgumentNullException">privateKeyPath is null</exception>
/// <exception cref="System.IO.PathTooLongException">
/// The specified path, filename, or both exceed the system-defined max
/// length
/// </exception>
/// <exception cref="System.IO.DirectoryNotFoundException">
/// The specified path is invalid, (for example, it is on an
/// unmapped drive).
/// </exception>
/// <exception cref="System.IO.FileNotFoundException">The file specified in path was not found.</exception>
/// <exception cref="System.NotSupportedException">path is in an invalid format.</exception>
/// <returns>CredentialsObject</returns>
public static Credentials FromAppIdAndPrivateKeyPath(string appId, string privateKeyPath)
if (!string.IsNullOrWhiteSpace(this.ApiKey) && !string.IsNullOrWhiteSpace(this.ApiSecret))
{
using var reader = File.OpenText(privateKeyPath);
var privateKey = reader.ReadToEnd();
return new Credentials {ApplicationId = appId, ApplicationKey = privateKey};
return AuthType.Basic;
}

/// <summary>
/// Provides the preferred authentication based on authentication type.
/// </summary>
/// <returns>The authentication header if it matches any criteria. A AuthenticationFailure otherwise.</returns>
public Result<AuthenticationHeaderValue> GetAuthenticationHeader() =>
this.GetPreferredAuthenticationType().Bind(this.GetPreferredAuthenticationHeader);

/// <summary>
/// Provides the preferred authentication type.
/// </summary>
/// <returns>The authentication type if it matches any criteria. A AuthenticationFailure otherwise.</returns>
/// <remarks>
/// Bearer will always be preferred over Basic if possible.
/// </remarks>
public Result<AuthType> GetPreferredAuthenticationType()
{
if (!string.IsNullOrWhiteSpace(this.ApplicationId) && !string.IsNullOrWhiteSpace(this.ApplicationKey))
{
return AuthType.Bearer;
}

if (!string.IsNullOrWhiteSpace(this.ApiKey) && !string.IsNullOrWhiteSpace(this.ApiSecret))
{
return AuthType.Basic;
}
return Result<AuthType>.FromFailure(new AuthenticationFailure());
}

return Result<AuthType>.FromFailure(new AuthenticationFailure());
}
/// <summary>
/// Returns the user agent from credentials if not null, from configuration otherwise.
/// </summary>
/// <returns>The user agent.</returns>
public string GetUserAgent() =>
this.AppUserAgent ?? Configuration.Instance.Settings["vonage:Vonage.UserAgent"];

/// <summary>
/// Returns the user agent from credentials if not null, from configuration otherwise.
/// </summary>
/// <returns>The user agent.</returns>
public string GetUserAgent() =>
this.AppUserAgent ?? Configuration.Instance.Settings["vonage:Vonage.UserAgent"];

private Result<AuthenticationHeaderValue> GetPreferredAuthenticationHeader(AuthType authenticationType) =>
authenticationType switch
{
AuthType.Basic => Result<AuthenticationHeaderValue>.FromSuccess(new AuthenticationHeaderValue("Basic",
Convert.ToBase64String(Encoding.UTF8.GetBytes($"{this.ApiKey}:{this.ApiSecret}")))),
AuthType.Bearer => new Jwt().GenerateToken(this)
.Map(token => new AuthenticationHeaderValue("Bearer", token)),
_ => Result<AuthenticationHeaderValue>.FromFailure(new AuthenticationFailure()),
};
}
private Result<AuthenticationHeaderValue> GetPreferredAuthenticationHeader(AuthType authenticationType) =>
authenticationType switch
{
AuthType.Basic => Result<AuthenticationHeaderValue>.FromSuccess(new AuthenticationHeaderValue("Basic",
Convert.ToBase64String(Encoding.UTF8.GetBytes($"{this.ApiKey}:{this.ApiSecret}")))),
AuthType.Bearer => new Jwt().GenerateToken(this)
.Map(token => new AuthenticationHeaderValue("Bearer", token)),
_ => Result<AuthenticationHeaderValue>.FromFailure(new AuthenticationFailure()),
};
}

0 comments on commit e701f21

Please sign in to comment.