Skip to content

Improve logging in federated credentials #4982

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jun 25, 2025
Merged

Improve logging in federated credentials #4982

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 28 additions & 10 deletions src/Commands/Base/TokenHandler.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@
using System.Text;
using System.Text.Json;
using System.Threading.Tasks;
using System.Web;

namespace PnP.PowerShell.Commands.Base
{
Expand Down Expand Up @@ -319,25 +320,32 @@ private static async Task<string> GetFederationTokenFromGithubAsync()
{
Framework.Diagnostics.Log.Debug("TokenHandler", "Retrieving GitHub federation token...");

var requestUrl = $"{Environment.GetEnvironmentVariable("ACTIONS_ID_TOKEN_REQUEST_URL")}&audience={Uri.EscapeDataString("api://AzureADTokenExchange")}";
var requestUrl = $"{Environment.GetEnvironmentVariable("ACTIONS_ID_TOKEN_REQUEST_URL")}&audience={UrlUtilities.UrlEncode("api://AzureADTokenExchange")}";

var httpClient = Framework.Http.PnPHttpClient.Instance.GetHttpClient();

using var requestMessage = new HttpRequestMessage(HttpMethod.Get, requestUrl);
requestMessage.Headers.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue("Bearer", Environment.GetEnvironmentVariable("ACTIONS_ID_TOKEN_REQUEST_TOKEN"));
requestMessage.Headers.Add("Accept", "application/json");
requestMessage.Headers.Add("x-anonymous", "true");

var response = await httpClient.SendAsync(requestMessage);
var responseContent = await response.Content.ReadAsStringAsync();

response.EnsureSuccessStatusCode();
if (!response.IsSuccessStatusCode)
{
responseContent = responseContent.Replace("{", "{{").Replace("}", "}}");
throw new HttpRequestException($"Failed to retrieve GitHub federation token. HTTP Error {response.StatusCode}: {responseContent}");
}

var content = await response.Content.ReadAsStringAsync();
var tokenResponse = JsonSerializer.Deserialize<Dictionary<string, object>>(content);
Framework.Diagnostics.Log.Debug("TokenHandler", "Successfully retrieved GitHub federation token...");
var tokenResponse = JsonSerializer.Deserialize<Dictionary<string, object>>(responseContent);

return tokenResponse["value"].ToString();
}
catch (Exception ex)
{
Framework.Diagnostics.Log.Error("TokenHandler GitHub", ex.Message);
throw new PSInvalidOperationException($"Failed to retrieve GitHub federation token: {ex.Message}", ex);
}
}
Expand All @@ -360,15 +368,22 @@ private static async Task<string> GetFederationTokenFromAzureDevOpsAsync(string
requestMessage.Headers.Add("x-anonymous", "true");

var response = await httpClient.SendAsync(requestMessage);
response.EnsureSuccessStatusCode();

var content = await response.Content.ReadAsStringAsync();
var tokenResponse = JsonSerializer.Deserialize<Dictionary<string, object>>(content);
var responseContent = await response.Content.ReadAsStringAsync();
if (!response.IsSuccessStatusCode)
{
responseContent = responseContent.Replace("{", "{{").Replace("}", "}}");
throw new HttpRequestException($"Failed to retrieve Azure DevOps federation token. HTTP Error {response.StatusCode}: {responseContent}");
}

Framework.Diagnostics.Log.Debug("TokenHandler", "Successfully retrieved Azure DevOps federation token...");
var tokenResponse = JsonSerializer.Deserialize<Dictionary<string, object>>(responseContent);

return tokenResponse["oidcToken"].ToString();
}
catch (Exception ex)
{
Framework.Diagnostics.Log.Error("TokenHandler AzureDevOps", ex.Message);
throw new PSInvalidOperationException($"Failed to retrieve Azure DevOps federation token: {ex.Message}", ex);
}
}
Expand All @@ -383,9 +398,9 @@ private static async Task<string> GetAccessTokenWithFederatedTokenAsync(string c
var queryParams = new List<string>
{
"grant_type=client_credentials",
$"scope={resource}",
$"scope={HttpUtility.UrlEncode(resource)}",
$"client_id={clientId}",
$"client_assertion_type=urn:ietf:params:oauth:client-assertion-type:jwt-bearer",
$"client_assertion_type={HttpUtility.UrlEncode("urn:ietf:params:oauth:client-assertion-type:jwt-bearer")}",
$"client_assertion={federatedToken}"
};

Expand All @@ -402,8 +417,11 @@ private static async Task<string> GetAccessTokenWithFederatedTokenAsync(string c
var responseContent = await response.Content.ReadAsStringAsync();
if (!response.IsSuccessStatusCode)
{
throw new HttpRequestException($"Failed to retrieve federated access token: HTTP Error {response.StatusCode}: {responseContent}");
responseContent = responseContent.Replace("{", "{{").Replace("}", "}}");
throw new HttpRequestException($"Failed to retrieve federated access token. HTTP Error {response.StatusCode}: {responseContent}");
}

Framework.Diagnostics.Log.Debug("TokenHandler", "Successfully retrieved federated access token...");
var tokenResponse = JsonSerializer.Deserialize<Dictionary<string, object>>(responseContent);

return tokenResponse["access_token"].ToString();
Expand Down
Loading