Skip to content

Commit

Permalink
refactor!: Use pure Rust rather than link to OpenSSL (#7)
Browse files Browse the repository at this point in the history
All the tests still pass, so this is at least equivalent to the previous
content, but without the OpenSSL dependency.

BREAKING CHANGE: This changes the type of
`EncodingError::InvalidKeyError` and adds another variant.
  • Loading branch information
cole-h authored Feb 25, 2024
1 parent 0392775 commit 6cdb7dd
Show file tree
Hide file tree
Showing 3 changed files with 27 additions and 35 deletions.
6 changes: 4 additions & 2 deletions Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -13,5 +13,7 @@ readme = "README.md"
# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html

[dependencies]
openssl = { version = "0.10", features = ["vendored"] }
thiserror = "1.0.24"
base64 = "0.21"
rsa = { version = "0.9", features = ["sha1"] }
sha1 = "0.10"
thiserror = "1.0.24"
20 changes: 1 addition & 19 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,6 @@
# AWS CloudFront Sign Utility
Generating signed URLs for CloudFront links is a little more tricky than for S3. It's because signature generation for S3 URLs is handled a bit differently than CloudFront URLs. The Rusoto library is in maintenance mode and not accepting more features. Therefore we created this simple utility library to sign CloudFront URLs in Rust.

## Requirements
OpenSSL need to be installed.

```
# macOS
$ brew install [email protected]
# Arch Linux
$ sudo pacman -S pkg-config openssl
# Debian and Ubuntu
$ sudo apt-get install pkg-config libssl-dev
# Fedora
$ sudo dnf install pkg-config openssl-devel
```


## Examples

Getting signed cookies.
Expand All @@ -45,4 +27,4 @@ let options = SignedOptions {
..Default::default()
};
let signed_url = get_signed_url("https://example.com", &options).unwrap();
```
```
36 changes: 22 additions & 14 deletions src/lib.rs
Original file line number Diff line number Diff line change
@@ -1,16 +1,18 @@
use openssl::{error::ErrorStack, hash::MessageDigest, pkey::PKey, rsa::Rsa, sign::Signer};
use std::{
collections::HashMap,
time::{SystemTime, UNIX_EPOCH},
u64,
};
use std::collections::HashMap;
use std::time::{SystemTime, UNIX_EPOCH};

use base64::{engine::general_purpose::STANDARD, Engine};
use rsa::pkcs1::DecodeRsaPrivateKey;
use sha1::{Digest, Sha1};
use thiserror::Error;

/// Possible errors encoding signed CloudFront URLS
#[derive(Error, Debug)]
pub enum EncodingError {
#[error("invalid key provided")]
InvalidKeyError(#[from] ErrorStack),
InvalidKeyError(#[from] rsa::pkcs1::Error),
#[error("failed to sign sha1 digest with rsa")]
RsaError(#[from] rsa::Error),
#[error("unknown error")]
Unknown,
}
Expand Down Expand Up @@ -82,7 +84,7 @@ pub fn get_signed_cookie(
let mut headers: HashMap<String, String> = HashMap::new();
let policy = get_custom_policy(url, options);
let signature = create_policy_signature(&policy, &options.private_key)?;
let policy_string = openssl::base64::encode_block(policy.as_bytes());
let policy_string = STANDARD.encode(policy.as_bytes());

headers.insert(
String::from("CloudFront-Policy"),
Expand All @@ -102,11 +104,17 @@ pub fn get_signed_cookie(

/// Create signature for a given policy and private key PEM-encoded PKCS#1
fn create_policy_signature(policy: &str, private_key: &str) -> Result<String, EncodingError> {
let rsa = Rsa::private_key_from_pem(private_key.as_bytes())?;
let keypair = PKey::from_rsa(rsa)?;
let mut signer = Signer::new(MessageDigest::sha1(), &keypair)?;
signer.update(policy.as_bytes())?;
Ok(openssl::base64::encode_block(&signer.sign_to_vec()?))
let rsa = rsa::RsaPrivateKey::from_pkcs1_pem(private_key)?;

let sha1_digest = {
let mut hasher = Sha1::new();
hasher.update(policy.as_bytes());
hasher.finalize()
};

let signed = rsa.sign(rsa::Pkcs1v15Sign::new::<Sha1>(), &sha1_digest)?;

Ok(STANDARD.encode(signed))
}

/// Create a URL safe Base64 encoded string.
Expand Down Expand Up @@ -140,7 +148,7 @@ pub fn get_signed_url(url: &str, options: &SignedOptions) -> Result<String, Enco
let signature = create_policy_signature(&policy, &options.private_key)?;

if options.date_greater_than.is_some() || options.ip_address.is_some() {
let policy_string = openssl::base64::encode_block(policy.as_bytes());
let policy_string = STANDARD.encode(policy.as_bytes());

Ok(format!(
"{}{}Expires={}&Policy={}&Signature={}&Key-Pair-Id={}",
Expand Down

0 comments on commit 6cdb7dd

Please sign in to comment.