Skip to content

Commit

Permalink
Expose subject name for MutualTlsUser
Browse files Browse the repository at this point in the history
This is not necessarily the value stored in the subject name of the
certificate, but it is the name for which the provided certifcate was
validated.
  • Loading branch information
akuanti committed Sep 11, 2018
1 parent aade841 commit 8ca69ce
Show file tree
Hide file tree
Showing 4 changed files with 35 additions and 7 deletions.
36 changes: 32 additions & 4 deletions core/http/src/tls.rs
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ pub fn find_valid_cert_for_peer<'a>(name: &'a str, certs: &'a [Certificate]) ->
/// ##Examples
///
/// The following short snippet shows `MutualTlsUser` being used as a request guard in a handler to
/// verify the client's certificate.
/// verify the client's certificate and print its subject name.
///
/// ```rust
/// # #![feature(plugin, decl_macro)]
Expand All @@ -55,12 +55,40 @@ pub fn find_valid_cert_for_peer<'a>(name: &'a str, certs: &'a [Certificate]) ->
/// use rocket::http::tls::MutualTlsUser;
///
/// #[get("/message")]
/// fn message(mtls:MutualTlsUser) {
/// println!("Authenticated client");
/// fn message(mtls: MutualTlsUser) {
/// println!("{}", mtls.subject_name());
/// }
///
/// # fn main() { }
/// ```
///
#[derive(Debug)]
pub struct MutualTlsUser {}
pub struct MutualTlsUser {
subject_name: String,
}

impl MutualTlsUser {
pub fn new(subject_name: &str) -> MutualTlsUser {
// NOTE: `subject_name` is not necessarily the subject name in the certificate,
// but it is the name for which the certificate was validated.
MutualTlsUser {
subject_name: subject_name.to_string()
}
}

/// Return the client's subject name.
///
/// # Example
///
/// ```rust
/// # extern crate rocket;
/// use rocket::http::tls::MutualTlsUser;
///
/// fn handler(mtls: MutualTlsUser) {
/// let subject_name = mtls.subject_name();
/// }
/// ```
pub fn subject_name(&self) -> &str {
&self.subject_name
}
}
2 changes: 1 addition & 1 deletion core/lib/src/request/from_request.rs
Original file line number Diff line number Diff line change
Expand Up @@ -469,6 +469,6 @@ impl <'a, 'r> FromRequest<'a, 'r> for MutualTlsUser {
// Validate the name against the provided certs and create a MutualTlsUser
find_valid_cert_for_peer(&name, &certs).or_forward(())?;

Success(MutualTlsUser {})
Success(MutualTlsUser::new(&name))
}
}
2 changes: 1 addition & 1 deletion examples/mtls/src/main.rs
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ use rocket::http::tls::MutualTlsUser;

#[get("/")]
fn hello(mtls: MutualTlsUser) -> String {
format!("Hello, MTLS world, {:?}!", mtls)
format!("Hello, MTLS world, {}!", mtls.subject_name())
}

fn main() {
Expand Down
2 changes: 1 addition & 1 deletion examples/mtls/src/tests.rs
Original file line number Diff line number Diff line change
Expand Up @@ -35,5 +35,5 @@ fn hello_world() {
.remote(socket)
.dispatch();

assert_eq!(response.body_string(), Some("Hello, MTLS world, MutualTlsUser!".into()));
assert_eq!(response.body_string(), Some("Hello, MTLS world, localhost!".into()));
}

0 comments on commit 8ca69ce

Please sign in to comment.