Skip to content
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

Add support for subresource integrity #76

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 2 additions & 0 deletions Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ license = "MIT/Apache-2.0"

[features]
sass = ["rsass"]
sri = ["ssri"]
mime02 = []
mime03 = ["mime"]
warp02 = ["mime03"]
Expand All @@ -24,6 +25,7 @@ md5 = "0.7"
nom = "5.0.0"

rsass = { version = "0.13.0", optional = true }
ssri = { version = "5.0.0", optional = true }
mime = { version = "0.3", optional = true }

[badges]
Expand Down
2 changes: 1 addition & 1 deletion examples/actix/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ edition = "2018"
build = "src/build.rs"

[build-dependencies]
ructe = { path = "../..", features = ["sass", "mime03"] }
ructe = { path = "../..", features = ["sass", "sri", "mime03"] }

[dependencies]
actix-web = "2.0.0"
Expand Down
2 changes: 1 addition & 1 deletion examples/actix/templates/error.rs.html
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
<head>
<title>Error @code.as_u16(): @code.canonical_reason().unwrap_or("error")</title>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<link rel="stylesheet" type="text/css" href="/static/@style_css.name"/>
<link rel="stylesheet" type="text/css" href="/static/@style_css.name" integrity="@style_css.integrity_sha384" />
</head>
<body>
<main>
Expand Down
2 changes: 1 addition & 1 deletion examples/actix/templates/page.rs.html
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
<head>
<title>Example</title>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<link rel="stylesheet" type="text/css" href="/static/@style_css.name"/>
<link rel="stylesheet" type="text/css" href="/static/@style_css.name" integrity="@style_css.integrity_sha384" />
</head>
<body>
<main>
Expand Down
2 changes: 1 addition & 1 deletion examples/ed2018/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ edition = "2018"
build = "src/build.rs"

[build-dependencies]
ructe = { path = "../..", features = ["mime03", "sass"] }
ructe = { path = "../..", features = ["mime03", "sri", "sass"] }

[dependencies]
mime = "~0.3"
2 changes: 1 addition & 1 deletion examples/ed2018/templates/page.rs.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<html>
<head>
<title>Example with stylesheet</title>
<link rel="stylesheet" href="/static/@style_css.name" type="text/css"/>
<link rel="stylesheet" href="/static/@style_css.name" type="text/css" integrity="@style_css.integrity_sha384" />
</head>
<body>
Hello world!
Expand Down
2 changes: 1 addition & 1 deletion examples/gotham/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ authors = ["Rasmus Kaj <kaj@kth.se>"]
build = "src/build.rs"

[build-dependencies]
ructe = { path = "../..", features = ["sass", "mime03"] }
ructe = { path = "../..", features = ["sass", "sri", "mime03"] }

[dependencies]
gotham = "0.4.0"
Expand Down
2 changes: 1 addition & 1 deletion examples/gotham/templates/page.rs.html
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
<head>
<title>Example</title>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<link rel="stylesheet" type="text/css" href="/static/@style_css.name"/>
<link rel="stylesheet" type="text/css" href="/static/@style_css.name" integrity="@style_css.integrity_sha384" />
</head>
<body>
<main>
Expand Down
2 changes: 1 addition & 1 deletion examples/iron/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ authors = ["Rasmus Kaj <kaj@kth.se>"]
build = "src/build.rs"

[build-dependencies]
ructe = { path = "../..", features = ["sass", "mime02"] }
ructe = { path = "../..", features = ["sass", "sri", "mime02"] }

[dependencies]
iron = "0.6"
Expand Down
2 changes: 1 addition & 1 deletion examples/iron/templates/page.rs.html
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
<head>
<title>Example</title>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<link rel="stylesheet" type="text/css" href="/static/@style_css.name"/>
<link rel="stylesheet" type="text/css" href="/static/@style_css.name" integrity="@style_css.integrity_sha384" />
</head>
<body>
<main>
Expand Down
2 changes: 1 addition & 1 deletion examples/nickel/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ authors = ["Rasmus Kaj <kaj@kth.se>"]
build = "src/build.rs"

[build-dependencies]
ructe = { path = "../..", features = ["sass", "mime02"] }
ructe = { path = "../..", features = ["sass", "sri", "mime02"] }

[dependencies]
nickel = "0.11.0"
Expand Down
2 changes: 1 addition & 1 deletion examples/nickel/templates/page.rs.html
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
<head>
<title>Example</title>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<link rel="stylesheet" type="text/css" href="/static/@style_css.name"/>
<link rel="stylesheet" type="text/css" href="/static/@style_css.name" integrity="@style_css.integrity_sha384" />
</head>
<body>
<main>
Expand Down
2 changes: 1 addition & 1 deletion examples/static-sass/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,4 @@ authors = ["Rasmus Kaj <kaj@kth.se>"]
build = "src/build.rs"

[build-dependencies]
ructe = { path = "../..", features = ["sass"] }
ructe = { path = "../..", features = ["sass", "sri"] }
2 changes: 1 addition & 1 deletion examples/static-sass/templates/page.rs.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<html>
<head>
<title>Example with stylesheet</title>
<link rel="stylesheet" href="/static/@style_css.name" type="text/css"/>
<link rel="stylesheet" href="/static/@style_css.name" type="text/css" integrity="@style_css.integrity_sha384" />
</head>
<body>
Hello world!
Expand Down
2 changes: 1 addition & 1 deletion examples/statics/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ authors = ["Rasmus Kaj <kaj@kth.se>"]
build = "src/build.rs"

[build-dependencies]
ructe = { path = "../..", features = ["mime03"] }
ructe = { path = "../..", features = ["sri", "mime03"] }

[dependencies]
mime = "0.3.0"
2 changes: 1 addition & 1 deletion examples/statics/templates/page.rs.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<html>
<head>
<title>Example with stylesheet</title>
<link rel="stylesheet" href="/static/@style_css.name" type="text/css"/>
<link rel="stylesheet" href="/static/@style_css.name" type="text/css" integrity="@style_css.integrity_sha384" />
</head>
<body>
Hello world!
Expand Down
2 changes: 1 addition & 1 deletion examples/warp02/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ edition = "2018"
build = "src/build.rs"

[build-dependencies]
ructe = { path = "../..", features = ["warp02", "sass"] }
ructe = { path = "../..", features = ["warp02", "sass", "sri"] }

[dependencies]
warp = "0.2.0"
Expand Down
2 changes: 1 addition & 1 deletion examples/warp02/templates/error.rs.html
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
<head>
<title>Error @code.as_u16(): @code.canonical_reason().unwrap_or("error")</title>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<link rel="stylesheet" type="text/css" href="/static/@style_css.name"/>
<link rel="stylesheet" type="text/css" href="/static/@style_css.name" integrity="@style_css.integrity_sha384" />
</head>
<body>
<main>
Expand Down
2 changes: 1 addition & 1 deletion examples/warp02/templates/page.rs.html
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
<head>
<title>Example</title>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<link rel="stylesheet" type="text/css" href="/static/@style_css.name"/>
<link rel="stylesheet" type="text/css" href="/static/@style_css.name" integrity="@style_css.integrity_sha384" />
</head>
<body>
<main>
Expand Down
7 changes: 6 additions & 1 deletion src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -90,6 +90,9 @@
//! version 0.2.x of the [mime] crate.
//! * `warp02` -- Provide an extension to [`Response::Builder`] to
//! simplify template rendering in the [warp] framework, versions 0.2.x.
//! * `sri` -- Generate [subresource
//! integrity](https://developer.mozilla.org/en-US/docs/Web/Security/Subresource_Integrity)
//! strings using the [ssri] crate
//!
//! [`response::Builder`]: ../http/response/struct.Builder.html
//! [mime]: https://crates.rs/crates/mime
Expand All @@ -103,7 +106,7 @@
//! build = "src/build.rs"
//!
//! [build-dependencies]
//! ructe = { version = "0.6.0", features = ["sass", "mime03"] }
//! ructe = { version = "0.6.0", features = ["sass", "sri", "mime03"] }
//!
//! [dependencies]
//! mime = "0.3.13"
Expand All @@ -118,6 +121,8 @@ extern crate mime;
extern crate nom;
#[cfg(feature = "sass")]
extern crate rsass;
#[cfg(feature = "sri")]
extern crate ssri;

pub mod Template_syntax;
mod expression;
Expand Down
82 changes: 75 additions & 7 deletions src/staticfiles.rs
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ use super::Result;
use base64;
use itertools::Itertools;
use md5;
use std::borrow::Cow;
use std::collections::BTreeMap;
use std::fmt::{self, Display};
use std::fs::{read_dir, File};
Expand Down Expand Up @@ -225,6 +226,11 @@ pub struct StaticFile {
if cfg!(feature = "mime03") {
src.write_all(b" pub mime: &'static Mime,\n")?;
}
if cfg!(feature = "sri") {
src.write_all(b" pub integrity_sha256: &'static str,\n")?;
src.write_all(b" pub integrity_sha384: &'static str,\n")?;
src.write_all(b" pub integrity_sha512: &'static str,\n")?;
}
src.write_all(
b"}
#[allow(dead_code)]
Expand Down Expand Up @@ -332,7 +338,7 @@ impl StaticFile {
&path,
&rust_name,
&url_name,
&FileContent(&path),
FileContent(&path),
ext,
)?;
}
Expand All @@ -350,7 +356,7 @@ impl StaticFile {
let path = &self.path_for(path);
let ext = name_and_ext(path).map(|(_, e)| e).unwrap_or("");
println!("cargo:rerun-if-changed={}", path.display());
self.add_static(path, url_name, url_name, &FileContent(path), ext)?;
self.add_static(path, url_name, url_name, FileContent(path), ext)?;
Ok(())
}

Expand Down Expand Up @@ -407,7 +413,7 @@ impl StaticFile {
path,
&rust_name,
&url_name,
&ByteString(data),
ByteString(data),
ext,
)?;
}
Expand Down Expand Up @@ -474,14 +480,17 @@ impl StaticFile {
self.add_file_data(&src.with_extension("css"), &css)
}

fn add_static(
fn add_static<'a, C>(
&mut self,
path: &Path,
rust_name: &str,
url_name: &str,
content: &impl Display,
content: C,
suffix: &str,
) -> io::Result<()> {
) -> io::Result<()>
where
C: Display + Into<Cow<'a, [u8]>>,
{
let rust_name = rust_name
.replace("/", "_")
.replace("-", "_")
Expand All @@ -494,12 +503,14 @@ impl StaticFile {
\n content: {content},\
\n name: \"{url_name}\",\
\n{mime}\
\n{sri}\
}};",
path = path,
rust_name = rust_name,
url_name = url_name,
content = content,
content = format!("{}", content),
mime = mime_arg(suffix),
sri = sri_args(&content.into()),
)?;
self.names.insert(rust_name.clone(), url_name.into());
self.names_r.insert(url_name.into(), rust_name);
Expand Down Expand Up @@ -560,6 +571,22 @@ impl<'a> Display for FileContent<'a> {
}
}

impl<'a> From<FileContent<'a>> for Cow<'a, [u8]> {
fn from(file_content: FileContent<'a>) -> Self {
let mut bytes = vec![];
let mut file = File::open(file_content.0).expect(&format!(
"path does not exist: {}",
file_content.0.display()
));
file.read_to_end(&mut bytes).expect(&format!(
"could not read file: {}",
file_content.0.display()
));

Cow::Owned(bytes)
}
}

struct ByteString<'a>(&'a [u8]);

impl<'a> Display for ByteString<'a> {
Expand All @@ -581,6 +608,12 @@ impl<'a> Display for ByteString<'a> {
}
}

impl<'a> From<ByteString<'a>> for Cow<'a, [u8]> {
fn from(bytes: ByteString<'a>) -> Self {
Cow::Borrowed(bytes.0)
}
}

fn name_and_ext(path: &Path) -> Option<(&str, &str)> {
if let (Some(name), Some(ext)) = (path.file_name(), path.extension()) {
if let (Some(name), Some(ext)) = (name.to_str(), ext.to_str()) {
Expand All @@ -594,6 +627,41 @@ fn name_and_ext(path: &Path) -> Option<(&str, &str)> {
fn checksum_slug(data: &[u8]) -> String {
base64::encode_config(&md5::compute(data)[..6], base64::URL_SAFE)
}

#[cfg(not(feature = "sri"))]
fn sri_args(_: &[u8]) -> String {
"".to_string()
}

#[cfg(feature = "sri")]
fn sri_args(content: &[u8]) -> String {
use ssri::{Algorithm, IntegrityOpts};

let sha256 = IntegrityOpts::new()
.algorithm(Algorithm::Sha256)
.chain(content)
.result()
.to_string();

let sha384 = IntegrityOpts::new()
.algorithm(Algorithm::Sha384)
.chain(content)
.result()
.to_string();
let sha512 = IntegrityOpts::new()
.algorithm(Algorithm::Sha512)
.chain(content)
.result()
.to_string();

format!(
"integrity_sha256: {sha256:?},\nintegrity_sha384: {sha384:?},\nintegrity_sha512: {sha512:?}",
sha256 = sha256,
sha384 = sha384,
sha512 = sha512,
)
}

#[cfg(not(feature = "mime02"))]
#[cfg(not(feature = "mime03"))]
fn mime_arg(_: &str) -> String {
Expand Down