-
Notifications
You must be signed in to change notification settings - Fork 151
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.
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
[wip] Added tempUrl generating capability #251
Open
haphan
wants to merge
2
commits into
master
Choose a base branch
from
swift-tempurl
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change | ||||
---|---|---|---|---|---|---|
|
@@ -78,4 +78,42 @@ public function containerExists(string $name): bool | |||||
throw $e; | ||||||
} | ||||||
} | ||||||
|
||||||
/** | ||||||
* Creates a temporary URL to access object in private containers. | ||||||
* This method loosely follows swift command's way to generate temporary url: `swift tempurl $METHOD $EXPIRE $PATH $KEY`. | ||||||
* | ||||||
* @param string $method An HTTP method to allow for this temporary URL. Any of GET, POST, HEAD, PUT, POST, DELETE. | ||||||
* @param int $expires Unix timestamp | ||||||
* @param string $path The full path or storage URL to the Swift object. Example: '/v1/AUTH_account/c/o' or: 'http://saio:8080/v1/AUTH_account/c/o' | ||||||
* For prefix based signature, set path to 'prefix:/v1/AUTH_account/container/pre' | ||||||
* @param string $key The secret temporary URL key set on the Swift cluster* | ||||||
* @param string $ipRange [OPTIONAL] If present, the temporary URL will be restricted to the given ip or ip range | ||||||
* @param string $digest [OPTIONAL] The digest algorithm to be used may be configured by the operator. Default to sha1. | ||||||
* Check the tempurl.allowed_digests entry in the cluster's capabilities response to see which algorithms are supported by your | ||||||
* deployment; | ||||||
* | ||||||
* @return string | ||||||
* | ||||||
* @throws \RuntimeException | ||||||
*/ | ||||||
public function tempUrl(string $method, int $expires, string $path, string $key, string $ipRange = null, string $digest = 'sha1'): string | ||||||
{ | ||||||
if (!function_exists('hash_hmac')) { | ||||||
throw new \RuntimeException(sprintf('tempUrl requires hash extension enabled.')); | ||||||
} | ||||||
|
||||||
if ($ipRange) { | ||||||
$message = sprintf("ip=%s\n%s\n%s\n%s", $ipRange, $method, $expires, $path); | ||||||
} else { | ||||||
$message = sprintf("%s\n%s\n%s", $method, $expires, $path); | ||||||
} | ||||||
|
||||||
$signature = hash_hmac($digest, $message, $key); | ||||||
|
||||||
// sha512 requires prefixing signature | ||||||
$signature = 'sha512' === $digest ? 'sha512:'.$signature : $signature; | ||||||
|
||||||
return sprintf('%s?temp_url_sig=%s&temp_url_expires=%s', $path, $signature, $expires); | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Given the $path is not encoded, I'd suggest encoding the actual temporary url path
Suggested change
|
||||||
} | ||||||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hi there. I just re-used this code as I need to generate temporary urls.
It took me a while to notice the issue but here it is in the doc "Do not URL-encode the path when you generate the HMAC-SHA1 signature. However, when you make the actual HTTP request, you should properly URL-encode the URL.".
I'd add this to the doc to ensure an non-encoded $path is passed in.