Skip to content

Commit

Permalink
feat(cpd-authentication): add apikey for authentication step and upda…
Browse files Browse the repository at this point in the history 
…te to use /v1/authorize
  • Loading branch information
@nan2iz
nan2iz committed Oct 12, 2021
1 parent 5df6f5b commit d92e59b
Show file tree
Hide file tree
Showing 3 changed files with 107 additions and 32 deletions.
119 changes: 104 additions & 15 deletions src/IBM.Cloud.SDK.Core/Authentication/CloudPakForData/CloudPakForDataAuthenticator.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,8 @@
using IBM.Cloud.SDK.Core.Util;
using System;
using System.Collections.Generic;

using System.Net.Http;

namespace IBM.Cloud.SDK.Core.Authentication.Cp4d
{
/// <summary>
Expand All @@ -30,12 +31,18 @@ public class CloudPakForDataAuthenticator : Authenticator
public IClient Client { get; set; }

// This is the suffix we'll need to add to the user-supplied URL to retrieve an access token.
private static string UrlSuffix = "/v1/preauth/validateAuth";
private static string UrlSuffix = "/v1/authorize";

// These are keys for body request for cpd authorization token
private const string UsernameKey = "username";
private const string PasswordKey = "password";
private const string ApikeyKey = "api_key";

// Configuration properties for this authenticator.
public string Url { get; private set; }
public string Username { get; private set; }
public string Password { get; private set; }
public string Apikey { get; private set; }
public bool? DisableSslVerification { get; set; }
public Dictionary<string, string> Headers { get; set; }

Expand All @@ -45,14 +52,28 @@ public class CloudPakForDataAuthenticator : Authenticator
/// <summary>
/// Constructs a CloudPakForDataAuthenticator with all properties.
/// </summary>
/// <param name="url">The base URL associated with the token server. The path "/v1/preauth/validateAuth" will be appended to this value automatically.</param>
/// <param name="url">The base URL associated with the token server. The path "/v1/authorize" will be appended to this value automatically.</param>
/// <param name="username">The username to be used when retrieving the access token</param>
/// <param name="password">The password to be used when retrieving the access token</param>
/// <param name="disableSslVerification">A flag indicating whether SSL hostname verification should be disabled</param>
/// <param name="headers">A set of user-supplied headers to be included in token server interactions</param>
public CloudPakForDataAuthenticator(string url, string username, string password, bool? disableSslVerification = null, Dictionary<string, string> headers = null)
{
Init(url, username, password, disableSslVerification, headers);
Init(url, username, password, null, disableSslVerification, headers);
}

/// <summary>
/// Constructs a CloudPakForDataAuthenticator with all properties.
/// </summary>
/// <param name="url">The base URL associated with the token server. The path "/v1/authorize" will be appended to this value automatically.</param>
/// <param name="username">The username to be used when retrieving the access token</param>
/// <param name="password">The password to be used when retrieving the access token</param>
/// <param name="apikey">The apikey to be used when retrieving the access token</param>
/// <param name="disableSslVerification">A flag indicating whether SSL hostname verification should be disabled</param>
/// <param name="headers">A set of user-supplied headers to be included in token server interactions</param>
public CloudPakForDataAuthenticator(string url, string username, string? password, string? apikey, bool? disableSslVerification = null, Dictionary<string, string> headers = null)
{
Init(url, username, password, apikey, disableSslVerification, headers);
}

/// <summary>
Expand All @@ -64,16 +85,61 @@ public CloudPakForDataAuthenticator(Dictionary<string, string> config)
config.TryGetValue(PropNameUrl, out string url);
config.TryGetValue(PropNameUsername, out string username);
config.TryGetValue(PropNamePassword, out string password);
config.TryGetValue(PropNameApikey, out string apikey);
config.TryGetValue(PropNameDisableSslVerification, out string disableSslVerficiationString);
bool.TryParse(disableSslVerficiationString, out bool disableSslVerification);
Init(url, username, password, disableSslVerification);
Init(url, username, password, apikey, disableSslVerification);
}

public CloudPakForDataAuthenticator SetUrl(string url)
{
this.Url = url;
return this;
}

public CloudPakForDataAuthenticator SetUsername(string username)
{
this.Username = username;
return this;
}

public CloudPakForDataAuthenticator setPassword(string password)
{
this.Password = this.Password;
return this;
}

private void Init(string url, string username, string password, bool? disableSslVerification = null, Dictionary<string, string> headers = null)
public CloudPakForDataAuthenticator setApikey(string apikey)
{
this.Apikey = this.Apikey;
return this;
}

public CloudPakForDataAuthenticator SetDisableSslVerification(bool disableSslVerification)
{
this.DisableSslVerification = disableSslVerification;
return this;
}

public CloudPakForDataAuthenticator SetHeaders(Dictionary<string, string> headers)
{
this.Headers = headers;
return this;
}

public CloudPakForDataAuthenticator Build()
{
Init();

return this;
}

private void Init(string url, string username, string? password, string? apikey, bool? disableSslVerification = null, Dictionary<string, string> headers = null)
{
Url = url;
Username = username;
Password = password;
Apikey = apikey;

if (disableSslVerification != null)
{
Expand All @@ -85,12 +151,17 @@ private void Init(string url, string username, string password, bool? disableSsl
Headers = headers;
}

Validate();
Init();
}

Client = new IBMHttpClient()
{
ServiceUrl = Url + UrlSuffix
};
public void Init()
{
Validate();

Client = new IBMHttpClient()
{
ServiceUrl = Url + UrlSuffix
};
}

public override string AuthenticationType
Expand Down Expand Up @@ -133,8 +204,9 @@ protected DetailedResponse<CloudPakForDataTokenResponse> RequestToken()

try
{
IClient client = Client.WithAuthentication(Username, Password);
var request = Client.GetAsync(Url + UrlSuffix);
var request = Client.PostAsync(Url + UrlSuffix);
request.WithHeader("Content-type", "application/x-www-form-urlencoded");

if (DisableSslVerification != null)
{
Client.DisableSslVerification((bool)DisableSslVerification);
Expand All @@ -145,6 +217,23 @@ protected DetailedResponse<CloudPakForDataTokenResponse> RequestToken()
request.WithHeaders(Headers);
}

List<KeyValuePair<string, string>> content = new List<KeyValuePair<string, string>>();
KeyValuePair<string, string> username = new KeyValuePair<string, string>(UsernameKey, Username);
content.Add(username);

if (string.IsNullOrEmpty(Password))
{
KeyValuePair<string, string> apikey = new KeyValuePair<string, string>(ApikeyKey, Apikey);
content.Add(apikey);
} else
{
KeyValuePair<string, string> password = new KeyValuePair<string, string>(PasswordKey, Password);
content.Add(password);
}

var formData = new FormUrlEncodedContent(content);
request.WithBodyContent(formData);

result = request.As<CloudPakForDataTokenResponse>().Result;
if (result == null)
{
Expand All @@ -171,9 +260,9 @@ public override void Validate()
throw new ArgumentNullException(string.Format(ErrorMessagePropMissing, "Username"));
}

if (string.IsNullOrEmpty(Password))
if (string.IsNullOrEmpty(Password) || string.IsNullOrEmpty(Apikey))
{
throw new ArgumentNullException(string.Format(ErrorMessagePropMissing, "Password"));
throw new ArgumentNullException("The Password or Apikey property is required but was not specified.");
}

if (CredentialUtils.HasBadStartOrEndChar(Url))
Expand Down
2 changes: 1 addition & 1 deletion src/IBM.Cloud.SDK.Core/Authentication/CloudPakForData/CloudPakForDataToken.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ public CloudPakForDataToken(string accessToken)

public CloudPakForDataToken(CloudPakForDataTokenResponse response)
{
AccessToken = response.AccessToken;
AccessToken = response.Token;
long? iat = null;
long? exp = null;

Expand Down
18 changes: 2 additions & 16 deletions src/IBM.Cloud.SDK.Core/Authentication/CloudPakForData/CloudPakForDataTokenResponse.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -27,22 +27,8 @@ namespace IBM.Cloud.SDK.Core.Authentication.Cp4d
/// </summary>
public class CloudPakForDataTokenResponse
{
[JsonProperty("username", NullValueHandling = NullValueHandling.Ignore)]
public string Username { get; set; }
[JsonProperty("role", NullValueHandling = NullValueHandling.Ignore)]
public string Role { get; set; }
[JsonProperty("permissions", NullValueHandling = NullValueHandling.Ignore)]
public List<string> Permissions { get; set; }
[JsonProperty("sub", NullValueHandling = NullValueHandling.Ignore)]
public string Sub { get; set; }
[JsonProperty("iss", NullValueHandling = NullValueHandling.Ignore)]
public string Iss { get; set; }
[JsonProperty("aud", NullValueHandling = NullValueHandling.Ignore)]
public string Aud { get; set; }
[JsonProperty("uid", NullValueHandling = NullValueHandling.Ignore)]
public string Uid { get; set; }
[JsonProperty("accessToken", NullValueHandling = NullValueHandling.Ignore)]
public string AccessToken { get; set; }
[JsonProperty("token", NullValueHandling = NullValueHandling.Ignore)]
public string Token { get; set; }
[JsonProperty("_messageCode_", NullValueHandling = NullValueHandling.Ignore)]
public string MessageCode { get; set; }
[JsonProperty("message", NullValueHandling = NullValueHandling.Ignore)]
Expand Down

0 comments on commit d92e59b

Please sign in to comment.