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.

Sign up for GitHub

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

Jump to bottom

Rename Authenticator.server_{cert,key}_fingerprint #164

Merged
merged 4 commits into from
Jul 20, 2024
Merged

Rename Authenticator.server_{cert,key}_fingerprint #164

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
9f6408a
Rename Authenticator.server_{cert,key}_fingerprint
reynir Nov 1, 2023
61b4824
Add CHANGES entry
reynir Jul 19, 2024
bbe3744
Update lib/x509.mli
hannesm Jul 20, 2024
54598c0
Update authenticator.ml
hannesm Jul 20, 2024
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
5 changes: 5 additions & 0 deletions CHANGES.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,11 @@
* Remove P224 (@dinosaure, @hannes, #166)
* The serial number of certificates is a `string` and enforced to be a positive
integer of at most 20 bytes in length (@hannesm, #167)
* **breaking change** `Authenticator.server_key_fingerprint` and
`Authenticator.server_cert_fingerprint` are now known as
`Authenticator.key_fingerprint` and `Authenticator.cert_fingerprint`
respectively to better reflect that they do not check extended key usage is
"server" and may as well be used for authenticating clients (@reynir, #164)

## v0.16.5 (2023-07-03)

Expand Down
4 changes: 2 additions & 2 deletions lib/authenticator.ml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,11 +15,11 @@ let chain_of_trust ~time ?crls ?(allowed_hashes = Validation.sha2) cas =
Validation.verify_chain_of_trust ?ip ~host ~time ?revoked ~allowed_hashes
~anchors:cas certificates

let server_key_fingerprint ~time ~hash ~fingerprint =
let key_fingerprint ~time ~hash ~fingerprint =
fun ?ip ~host certificates ->
Validation.trust_key_fingerprint ?ip ~host ~time ~hash ~fingerprint certificates

let server_cert_fingerprint ~time ~hash ~fingerprint =
let cert_fingerprint ~time ~hash ~fingerprint =
fun ?ip ~host certificates ->
Validation.trust_cert_fingerprint ?ip ~host ~time ~hash ~fingerprint certificates

Expand Down
10 changes: 5 additions & 5 deletions lib/x509.mli
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1000,22 +1000,22 @@ module Authenticator : sig
val chain_of_trust : time:(unit -> Ptime.t option) -> ?crls:CRL.t list ->
?allowed_hashes:Digestif.hash' list -> Certificate.t list -> t

(** [server_key_fingerprint ~time hash fingerprint] is an [authenticator]
(** [key_fingerprint ~time hash fingerprint] is an [authenticator]
that uses the given [time] and [fingerprint] to verify that the
fingerprint of the first element of the certificate chain matches the
given fingerprint, using {!Validation.trust_key_fingerprint}. *)
val server_key_fingerprint : time:(unit -> Ptime.t option) ->
val key_fingerprint : time:(unit -> Ptime.t option) ->
hash:Digestif.hash' -> fingerprint:string -> t

(** [server_cert_fingerprint ~time hash fingerprint] is an [authenticator]
(** [cert_fingerprint ~time hash fingerprint] is an [authenticator]
that uses the given [time] and [fingerprint] to verify the first
element of the certificate chain, using
{!Validation.trust_cert_fingerprint}. Note that
{{!server_key_fingerprint}public key pinning} has
{{:https://www.imperialviolet.org/2011/05/04/pinning.html} advantages}
over certificate pinning. *)
val server_cert_fingerprint : time:(unit -> Ptime.t option) ->
hash:Digestif.hash' -> fingerprint:string -> t
val cert_fingerprint : time:(unit -> Ptime.t option) ->
hash:Digestif.hash' -> fingerprint:Cstruct.t -> t
hannesm marked this conversation as resolved.
Show resolved Hide resolved

(** [of_string str] tries to parse the given [str] to an
{!type:Authenticator.t}. The format of it is:
Expand Down