-
-
Notifications
You must be signed in to change notification settings - Fork 594
Open
Description
Description
The downloadLogs() method in the WorkflowJobs and WorkflowRuns API fails when attempting to download GitHub Actions job logs. Instead of returning the log data, it fails with an Azure Blob Storage authentication error.
Environment
- Library version:
knplabs/github-api3.16.0 - PHP version: 8.x
- HTTP client: Guzzle 7.10.0 (via PSR-18 discovery)
Expected Behavior
Calling downloadLogs() should return the ZIP archive containing the job logs as documented in the library's API.
Actual Behavior
The method throws an exception or returns an XML error response from Azure Blob Storage:
<?xml version="1.0" encoding="utf-8"?>
<Error>
<Code>AuthenticationFailed</Code>
<Message>Server failed to authenticate the request. Make sure the value of Authorization header is formed correctly including the signature.</Message>
</Error>Root Cause
The GitHub API endpoint /repos/{owner}/{repo}/actions/jobs/{job_id}/logs returns a 302 redirect to an Azure Blob Storage URL with a pre-signed SAS token in the query parameters.
The issue occurs because:
- HTTPlug's
RedirectPluginis used by default in the library (added inClient.php) - The RedirectPlugin preserves ALL headers by default (
preserve_header: true) - When following the redirect to Azure Blob Storage, the GitHub
Authorizationheader is sent to Azure - Azure Blob Storage doesn't understand GitHub's authentication format and rejects the request
- Unlike Guzzle's native
RedirectMiddleware(which stripsAuthorizationandCookieheaders on cross-origin redirects), HTTPlug'sRedirectPluginhas no such protection
Reproduction Steps
- Set up GitHub API client with valid authentication token
- Get a valid job ID from a workflow run
- Call
downloadLogs()on that job ID - Observe the Azure authentication error
References
- GitHub API docs: https://docs.github.com/en/rest/actions/workflow-jobs#download-job-logs-for-a-workflow-run
- Guzzle's RedirectMiddleware (strips auth headers): https://github.com/guzzle/guzzle/blob/master/src/RedirectMiddleware.php#L174-L177
- HTTPlug RedirectPlugin (preserves all headers): https://github.com/php-http/client-common/blob/master/src/Plugin/RedirectPlugin.php
Metadata
Metadata
Assignees
Labels
No labels