350 lines
10 KiB
OCaml
350 lines
10 KiB
OCaml
(*****************************************************************************)
|
|
(* *)
|
|
(* Open Source License *)
|
|
(* Copyright (c) 2018 Dynamic Ledger Solutions, Inc. <contact@tezos.com> *)
|
|
(* *)
|
|
(* Permission is hereby granted, free of charge, to any person obtaining a *)
|
|
(* copy of this software and associated documentation files (the "Software"),*)
|
|
(* to deal in the Software without restriction, including without limitation *)
|
|
(* the rights to use, copy, modify, merge, publish, distribute, sublicense, *)
|
|
(* and/or sell copies of the Software, and to permit persons to whom the *)
|
|
(* Software is furnished to do so, subject to the following conditions: *)
|
|
(* *)
|
|
(* The above copyright notice and this permission notice shall be included *)
|
|
(* in all copies or substantial portions of the Software. *)
|
|
(* *)
|
|
(* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR*)
|
|
(* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, *)
|
|
(* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL *)
|
|
(* THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER*)
|
|
(* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING *)
|
|
(* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER *)
|
|
(* DEALINGS IN THE SOFTWARE. *)
|
|
(* *)
|
|
(*****************************************************************************)
|
|
|
|
open Error_monad
|
|
|
|
module Public_key_hash = struct
|
|
include Blake2B.Make(Base58)(struct
|
|
let name = "Ed25519.Public_key_hash"
|
|
let title = "An Ed25519 public key hash"
|
|
let b58check_prefix = Base58.Prefix.ed25519_public_key_hash
|
|
let size = Some 20
|
|
end)
|
|
module Logging = struct
|
|
let tag = Tag.def ~doc:title name pp
|
|
end
|
|
end
|
|
let () =
|
|
Base58.check_encoded_prefix Public_key_hash.b58check_encoding "tz1" 36
|
|
|
|
open Hacl
|
|
|
|
module Public_key = struct
|
|
|
|
type t = public Sign.key
|
|
|
|
let name = "Ed25519.Public_key"
|
|
let title = "Ed25519 public key"
|
|
|
|
let to_string s = MBytes.to_string (Sign.unsafe_to_bytes s)
|
|
let of_string_opt s =
|
|
if String.length s < Sign.pkbytes then None
|
|
else
|
|
let pk = MBytes.create Sign.pkbytes in
|
|
MBytes.blit_of_string s 0 pk 0 Sign.pkbytes ;
|
|
Some (Sign.unsafe_pk_of_bytes pk)
|
|
|
|
let to_bytes pk =
|
|
let buf = MBytes.create Sign.pkbytes in
|
|
Sign.blit_to_bytes pk buf ;
|
|
buf
|
|
|
|
let of_bytes_opt buf =
|
|
let buflen = MBytes.length buf in
|
|
if buflen < Sign.pkbytes then None
|
|
else
|
|
let pk = MBytes.create Sign.pkbytes in
|
|
MBytes.blit buf 0 pk 0 Sign.pkbytes ;
|
|
Some (Sign.unsafe_pk_of_bytes pk)
|
|
|
|
let size = Sign.pkbytes
|
|
|
|
type Base58.data +=
|
|
| Data of t
|
|
|
|
let b58check_encoding =
|
|
Base58.register_encoding
|
|
~prefix: Base58.Prefix.ed25519_public_key
|
|
~length: size
|
|
~to_raw: to_string
|
|
~of_raw: of_string_opt
|
|
~wrap: (fun x -> Data x)
|
|
|
|
let () =
|
|
Base58.check_encoded_prefix b58check_encoding "edpk" 54
|
|
|
|
let hash v =
|
|
Public_key_hash.hash_bytes [ Sign.unsafe_to_bytes v ]
|
|
|
|
include Compare.Make(struct
|
|
type nonrec t = t
|
|
let compare a b =
|
|
MBytes.compare (Sign.unsafe_to_bytes a) (Sign.unsafe_to_bytes b)
|
|
end)
|
|
|
|
include Helpers.MakeRaw(struct
|
|
type nonrec t = t
|
|
let name = name
|
|
let of_bytes_opt = of_bytes_opt
|
|
let of_string_opt = of_string_opt
|
|
let to_string = to_string
|
|
end)
|
|
|
|
include Helpers.MakeB58(struct
|
|
type nonrec t = t
|
|
let title = title
|
|
let name = name
|
|
let b58check_encoding = b58check_encoding
|
|
end)
|
|
|
|
include Helpers.MakeEncoder(struct
|
|
type nonrec t = t
|
|
let name = name
|
|
let title = title
|
|
let raw_encoding =
|
|
let open Data_encoding in
|
|
conv to_bytes of_bytes_exn (Fixed.bytes size)
|
|
let of_b58check = of_b58check
|
|
let of_b58check_opt = of_b58check_opt
|
|
let of_b58check_exn = of_b58check_exn
|
|
let to_b58check = to_b58check
|
|
let to_short_b58check = to_short_b58check
|
|
end)
|
|
|
|
let pp ppf t = Format.fprintf ppf "%s" (to_b58check t)
|
|
|
|
end
|
|
|
|
module Secret_key = struct
|
|
|
|
type t = secret Sign.key
|
|
|
|
let name = "Ed25519.Secret_key"
|
|
let title = "An Ed25519 secret key"
|
|
|
|
let size = Sign.skbytes
|
|
|
|
let to_bytes sk =
|
|
let buf = MBytes.create Sign.skbytes in
|
|
Sign.blit_to_bytes sk buf ;
|
|
buf
|
|
|
|
let of_bytes_opt s =
|
|
if MBytes.length s > 64 then None
|
|
else
|
|
let sk = MBytes.create Sign.skbytes in
|
|
MBytes.blit s 0 sk 0 Sign.skbytes ;
|
|
Some (Sign.unsafe_sk_of_bytes sk)
|
|
|
|
let to_string s = MBytes.to_string (to_bytes s)
|
|
let of_string_opt s = of_bytes_opt (MBytes.of_string s)
|
|
|
|
let to_public_key = Sign.neuterize
|
|
|
|
type Base58.data +=
|
|
| Data of t
|
|
|
|
let b58check_encoding =
|
|
Base58.register_encoding
|
|
~prefix: Base58.Prefix.ed25519_seed
|
|
~length: size
|
|
~to_raw: (fun sk -> MBytes.to_string (Sign.unsafe_to_bytes sk))
|
|
~of_raw: (fun buf ->
|
|
if String.length buf <> Sign.skbytes then None
|
|
else Some (Sign.unsafe_sk_of_bytes (MBytes.of_string buf)))
|
|
~wrap: (fun sk -> Data sk)
|
|
|
|
(* Legacy NaCl secret key encoding. Used to store both sk and pk. *)
|
|
let secret_key_encoding =
|
|
Base58.register_encoding
|
|
~prefix: Base58.Prefix.ed25519_secret_key
|
|
~length: Sign.(skbytes + pkbytes)
|
|
~to_raw: (fun sk ->
|
|
let pk = Sign.neuterize sk in
|
|
let buf = MBytes.create Sign.(skbytes + pkbytes) in
|
|
Sign.blit_to_bytes sk buf ;
|
|
Sign.blit_to_bytes pk ~pos:Sign.skbytes buf ;
|
|
MBytes.to_string buf)
|
|
~of_raw: (fun buf ->
|
|
if String.length buf <> Sign.(skbytes + pkbytes) then None
|
|
else
|
|
let sk = MBytes.create Sign.skbytes in
|
|
MBytes.blit_of_string buf 0 sk 0 Sign.skbytes ;
|
|
Some (Sign.unsafe_sk_of_bytes sk))
|
|
~wrap: (fun x -> Data x)
|
|
|
|
let of_b58check_opt s =
|
|
match Base58.simple_decode b58check_encoding s with
|
|
| Some x -> Some x
|
|
| None -> Base58.simple_decode secret_key_encoding s
|
|
let of_b58check_exn s =
|
|
match of_b58check_opt s with
|
|
| Some x -> x
|
|
| None -> Format.kasprintf Pervasives.failwith "Unexpected data (%s)" name
|
|
let of_b58check s =
|
|
match of_b58check_opt s with
|
|
| Some x -> Ok x
|
|
| None ->
|
|
generic_error
|
|
"Failed to read a b58check_encoding data (%s): %S"
|
|
name s
|
|
|
|
let to_b58check s = Base58.simple_encode b58check_encoding s
|
|
let to_short_b58check s =
|
|
String.sub
|
|
(to_b58check s) 0
|
|
(10 + String.length (Base58.prefix b58check_encoding))
|
|
|
|
let () =
|
|
Base58.check_encoded_prefix b58check_encoding "edsk" 54 ;
|
|
Base58.check_encoded_prefix secret_key_encoding "edsk" 98
|
|
|
|
include Compare.Make(struct
|
|
type nonrec t = t
|
|
let compare a b =
|
|
MBytes.compare (Sign.unsafe_to_bytes a) (Sign.unsafe_to_bytes b)
|
|
end)
|
|
|
|
include Helpers.MakeRaw(struct
|
|
type nonrec t = t
|
|
let name = name
|
|
let of_bytes_opt = of_bytes_opt
|
|
let of_string_opt = of_string_opt
|
|
let to_string = to_string
|
|
end)
|
|
|
|
include Helpers.MakeEncoder(struct
|
|
type nonrec t = t
|
|
let name = name
|
|
let title = title
|
|
let raw_encoding =
|
|
let open Data_encoding in
|
|
conv to_bytes of_bytes_exn (Fixed.bytes size)
|
|
let of_b58check = of_b58check
|
|
let of_b58check_opt = of_b58check_opt
|
|
let of_b58check_exn = of_b58check_exn
|
|
let to_b58check = to_b58check
|
|
let to_short_b58check = to_short_b58check
|
|
end)
|
|
|
|
let pp ppf t = Format.fprintf ppf "%s" (to_b58check t)
|
|
|
|
end
|
|
|
|
type t = MBytes.t
|
|
|
|
type watermark = MBytes.t
|
|
|
|
let name = "Ed25519"
|
|
let title = "An Ed25519 signature"
|
|
|
|
let size = Sign.bytes
|
|
|
|
let of_bytes_opt s =
|
|
if MBytes.length s = size then Some s else None
|
|
let to_bytes x = x
|
|
|
|
let to_string s = MBytes.to_string (to_bytes s)
|
|
let of_string_opt s = of_bytes_opt (MBytes.of_string s)
|
|
|
|
type Base58.data +=
|
|
| Data of t
|
|
|
|
let b58check_encoding =
|
|
Base58.register_encoding
|
|
~prefix: Base58.Prefix.ed25519_signature
|
|
~length: size
|
|
~to_raw: MBytes.to_string
|
|
~of_raw: (fun s -> Some (MBytes.of_string s))
|
|
~wrap: (fun x -> Data x)
|
|
|
|
let () =
|
|
Base58.check_encoded_prefix b58check_encoding "edsig" 99
|
|
|
|
include Helpers.MakeRaw(struct
|
|
type nonrec t = t
|
|
let name = name
|
|
let of_bytes_opt = of_bytes_opt
|
|
let of_string_opt = of_string_opt
|
|
let to_string = to_string
|
|
end)
|
|
|
|
include Helpers.MakeB58(struct
|
|
type nonrec t = t
|
|
let title = title
|
|
let name = name
|
|
let b58check_encoding = b58check_encoding
|
|
end)
|
|
|
|
include Helpers.MakeEncoder(struct
|
|
type nonrec t = t
|
|
let name = name
|
|
let title = title
|
|
let raw_encoding =
|
|
let open Data_encoding in
|
|
conv to_bytes of_bytes_exn (Fixed.bytes size)
|
|
let of_b58check = of_b58check
|
|
let of_b58check_opt = of_b58check_opt
|
|
let of_b58check_exn = of_b58check_exn
|
|
let to_b58check = to_b58check
|
|
let to_short_b58check = to_short_b58check
|
|
end)
|
|
|
|
let pp ppf t = Format.fprintf ppf "%s" (to_b58check t)
|
|
|
|
let zero = MBytes.make size '\000'
|
|
|
|
let sign ?watermark sk msg =
|
|
let msg =
|
|
Blake2B.to_bytes @@
|
|
Blake2B.hash_bytes @@
|
|
match watermark with
|
|
| None -> [msg]
|
|
| Some prefix -> [ prefix ; msg ] in
|
|
let signature = MBytes.create Sign.bytes in
|
|
Sign.sign ~sk ~msg ~signature ;
|
|
signature
|
|
|
|
let check ?watermark pk signature msg =
|
|
let msg =
|
|
Blake2B.to_bytes @@
|
|
Blake2B.hash_bytes @@
|
|
match watermark with
|
|
| None -> [msg]
|
|
| Some prefix -> [ prefix ; msg ] in
|
|
Sign.verify ~pk ~signature ~msg
|
|
|
|
let generate_key ?seed () =
|
|
match seed with
|
|
| None ->
|
|
let pk, sk = Sign.keypair () in
|
|
Public_key.hash pk, pk, sk
|
|
| Some seed ->
|
|
let seedlen = MBytes.length seed in
|
|
if seedlen < Sign.skbytes then
|
|
invalid_arg (Printf.sprintf "Ed25519.generate_key: seed must \
|
|
be at least %d bytes long (got %d)"
|
|
Sign.skbytes seedlen) ;
|
|
let sk = MBytes.create Sign.skbytes in
|
|
MBytes.blit seed 0 sk 0 Sign.skbytes ;
|
|
let sk = Sign.unsafe_sk_of_bytes sk in
|
|
let pk = Sign.neuterize sk in
|
|
Public_key.hash pk, pk, sk
|
|
|
|
include Compare.Make(struct
|
|
type nonrec t = t
|
|
let compare = MBytes.compare
|
|
end)
|