Infrastructure/imageproxy
0
Fork 0
mirror of https://github.com/willnorris/imageproxy.git synced 2025-03-11 02:19:14 -05:00
Code Issues Activity

docs: make url signing examples more consistent

Browse source 
use consistent values for url and key and similar calling styles
(passing values as command line arguments.  Also use more utilities from
the language standard library, such as java.util.Base64.
This commit is contained in:
Will Norris 2019-05-13 13:07:51 -05:00
parent 7af1b52eef
commit 6ec1036afb
1 changed files with 51 additions and 36 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

87
docs/url-signing.md
View file

@ -63,7 +63,9 @@ options are sorted, moving `q75` before `r90`.
## Language Examples ## Language Examples
Here are examples of calculating signatures in a variety of languages. These Here are examples of calculating signatures in a variety of languages. These
demonstrate the HMAC-SHA256 bits, but not the option canonicalization. demonstrate the HMAC-SHA256 bits, but not the option canonicalization. In each
example, the remote URL `https://octodex.github.com/images/codercat.jpg` is
signed using a signature key of `secretkey`.
See also the [imageproxy-sign tool](/cmd/imageproxy-sign). See also the [imageproxy-sign tool](/cmd/imageproxy-sign).
@ -82,52 +84,53 @@ import (
) )
func main() { func main() {
mac := hmac.New(sha256.New, []byte(os.Args[1])) key, url := os.Args[1], os.Args[2]
mac.Write([]byte(os.Args[2])) mac := hmac.New(sha256.New, []byte(key))
want := mac.Sum(nil) mac.Write([]byte(url))
fmt.Println("result: ",base64.URLEncoding.EncodeToString(want)) result := mac.Sum(nil)
fmt.Println(base64.URLEncoding.EncodeToString(result))
} }
``` ```
```shell ```shell
$ go run main.go "test" "https://www.google.fr/images/srpr/logo11w.png" $ go run sign.go "secretkey" "https://octodex.github.com/images/codercat.jpg"
result: RYifAJRfbhsitJeOrDNxWURCCkPsVR4ihCPXNv-ePbA= cw34eyalj8YvpLpETxSIxv2k8QkLel2UAR5Cku2FzGM=
``` ```
### OpenSSL ### OpenSSL
```shell ```shell
$ echo -n "https://www.google.fr/images/srpr/logo11w.png" | openssl dgst -sha256 -hmac "test" -binary|base64| tr '/+' '_-' $ echo -n "https://octodex.github.com/images/codercat.jpg" | openssl dgst -sha256 -hmac "secretkey" -binary|base64| tr '/+' '_-'
RYifAJRfbhsitJeOrDNxWURCCkPsVR4ihCPXNv-ePbA= cw34eyalj8YvpLpETxSIxv2k8QkLel2UAR5Cku2FzGM=
``` ```
### Java ### Java
```java ```java
import org.apache.commons.codec.binary.Base64; import java.util.Base64;
import javax.crypto.Mac; import javax.crypto.Mac;
import javax.crypto.spec.SecretKeySpec; import javax.crypto.spec.SecretKeySpec;
class EncodeUrl { class SignUrl {
public static String encode(String key, String data) throws Exception { public static String sign(String key, String url) throws Exception {
Mac sha256_HMAC = Mac.getInstance("HmacSHA256"); Mac sha256_HMAC = Mac.getInstance("HmacSHA256");
SecretKeySpec secret_key = new SecretKeySpec(key.getBytes(), "HmacSHA256"); SecretKeySpec secret_key = new SecretKeySpec(key.getBytes(), "HmacSHA256");
sha256_HMAC.init(secret_key); sha256_HMAC.init(secret_key);
return Base64.encodeBase64URLSafeString(sha256_HMAC.doFinal(data.getBytes())); return Base64.getUrlEncoder().encodeToString(sha256_HMAC.doFinal(url.getBytes()));
} }
public static void main(String [] args) throws Exception { public static void main(String [] args) throws Exception {
System.out.println(encode(args[0], args[1])); System.out.println(sign(args[0], args[1]));
} }
} }
``` ```
```shell ```shell
$ java -cp commons-codec-1.10.jar:. EncodeUrl test https://www.google.fr/images/srpr/logo11w.png $ javac SignUrl.java && java SignUrl "secretkey" "https://octodex.github.com/images/codercat.jpg"
RYifAJRfbhsitJeOrDNxWURCCkPsVR4ihCPXNv-ePbA cw34eyalj8YvpLpETxSIxv2k8QkLel2UAR5Cku2FzGM=
``` ```
### Ruby ### Ruby
@ -136,49 +139,61 @@ RYifAJRfbhsitJeOrDNxWURCCkPsVR4ihCPXNv-ePbA
require 'openssl' require 'openssl'
require 'base64' require 'base64'
key = "test" key = ARGV[0]
data = "https://www.google.fr/images/srpr/logo11w.png" url = ARGV[1]
puts Base64.urlsafe_encode64(OpenSSL::HMAC.digest(OpenSSL::Digest.new('sha256'), key, data)).strip() puts Base64.urlsafe_encode64(OpenSSL::HMAC.digest(OpenSSL::Digest.new('sha256'), key, url)).strip()
``` ```
```shell ```shell
% ruby sign.rb % ruby sign.rb "secretkey" "https://octodex.github.com/images/codercat.jpg"
RYifAJRfbhsitJeOrDNxWURCCkPsVR4ihCPXNv-ePbA= cw34eyalj8YvpLpETxSIxv2k8QkLel2UAR5Cku2FzGM=
``` ```
### Python ### Python
```python ```python
import hmac
import hashlib
import base64 import base64
import hashlib
import hmac
import sys
key = 'secret key' key = sys.argv[1]
data = 'https://octodex.github.com/images/codercat.jpg' url = sys.argv[2]
print base64.urlsafe_b64encode(hmac.new(key, msg=data, digestmod=hashlib.sha256).digest()) print base64.urlsafe_b64encode(hmac.new(key, msg=url, digestmod=hashlib.sha256).digest())
``` ```
````shell
$ python sign.py "secretkey" "https://octodex.github.com/images/codercat.jpg"
cw34eyalj8YvpLpETxSIxv2k8QkLel2UAR5Cku2FzGM=
````
### JavaScript ### JavaScript
```javascript ```javascript
import crypto from 'crypto'; const crypto = require('crypto');
import URLSafeBase64 from 'urlsafe-base64'; const URLSafeBase64 = require('urlsafe-base64');
let key = 'secret key'; let key = process.argv[2];
let data = 'https://octodex.github.com/images/codercat.jpg'; let url = process.argv[3];
console.log(URLSafeBase64.encode(crypto.createHmac('sha256', key).update(data).digest())); console.log(URLSafeBase64.encode(crypto.createHmac('sha256', key).update(url).digest()));
``` ```
````shell
$ node sign.js "secretkey" "https://octodex.github.com/images/codercat.jpg"
cw34eyalj8YvpLpETxSIxv2k8QkLel2UAR5Cku2FzGM=
````
### PHP ### PHP
````php ````php
<?php <?php
$key = 'test';
$data = "https://www.google.fr/images/srpr/logo11w.png"; $key = $argv[1];
echo strtr(base64_encode(hash_hmac('sha256', $data, $key, 1)), '/+' , '_-'); $url = $argv[2];
echo strtr(base64_encode(hash_hmac('sha256', $url, $key, 1)), '/+' , '_-');
```` ````
````shell ````shell
$ php ex.php $ php sign.php "secretkey" "https://octodex.github.com/images/codercat.jpg"
RYifAJRfbhsitJeOrDNxWURCCkPsVR4ihCPXNv-ePbA= cw34eyalj8YvpLpETxSIxv2k8QkLel2UAR5Cku2FzGM=
```` ````