Skip to content

Yet more sexps #250

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

Merged
hannesm merged 4 commits into from
May 15, 2015
Merged

Yet more sexps #250

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
9e93a6a
remove Cstruct_s
pqwy Feb 8, 2015
81719d2
remove Sexp_ext
pqwy Feb 8, 2015
c86365f
_oasis, regenerate
pqwy Feb 8, 2015
d4c3775
opam: require cstruct-1.6.0
pqwy May 1, 2015
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: 1 addition & 1 deletion _oasis
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Library "tls"
Modules : Tracing, Ciphersuite, Packet, Core,
Printer, Reader, Writer, Config,
Engine
InternalModules : Control, Sexp_ext, Crypto, Utils,
InternalModules : Control, Crypto, Utils,
State, Handshake_common, Handshake_crypto,
Handshake_server, Handshake_client
Pack : true
Expand Down
3 changes: 1 addition & 2 deletions _tags
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# OASIS_START
# DO NOT EDIT (digest: 5eb87f1a9699084a7ce0fa5335b76193)
# DO NOT EDIT (digest: 23e4e9c6084252c78d7e3c085c6f050c)
# Ignore VCS directories, you can use the same kind of rule outside
# OASIS_START/STOP if you want to exclude directories that contains
# useless stuff for the build process
Expand All @@ -26,7 +26,6 @@ true: annot, bin_annot
"lib/config.cmx": for-pack(Tls)
"lib/engine.cmx": for-pack(Tls)
"lib/control.cmx": for-pack(Tls)
"lib/sexp_ext.cmx": for-pack(Tls)
"lib/crypto.cmx": for-pack(Tls)
"lib/utils.cmx": for-pack(Tls)
"lib/state.cmx": for-pack(Tls)
Expand Down
58 changes: 28 additions & 30 deletions lib/core.ml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,6 @@ open Nocrypto
open Packet
open Ciphersuite

module Cstruct_s = Sexp_ext.Cstruct_s

type tls_version =
| TLS_1_0
| TLS_1_1
Expand Down Expand Up @@ -73,16 +71,16 @@ type extension =
| MaxFragmentLength of max_fragment_length
| EllipticCurves of named_curve_type list
| ECPointFormats of ec_point_format list
| SecureRenegotiation of Cstruct_s.t
| SecureRenegotiation of Cstruct.t
| Padding of int
| SignatureAlgorithms of (Hash.hash * signature_algorithm_type) list
| UnknownExtension of (int * Cstruct_s.t)
| UnknownExtension of (int * Cstruct.t)
with sexp

type ('a, 'b) hello = {
version : 'b;
random : Cstruct_s.t;
sessionid : Cstruct_s.t option;
random : Cstruct.t;
sessionid : Cstruct.t option;
ciphersuites : 'a;
extensions : extension list
} with sexp
Expand All @@ -94,58 +92,58 @@ type server_hello = (ciphersuite, tls_version) hello
with sexp

type rsa_parameters = {
rsa_modulus : Cstruct_s.t;
rsa_exponent : Cstruct_s.t;
rsa_modulus : Cstruct.t;
rsa_exponent : Cstruct.t;
} with sexp

type dh_parameters = {
dh_p : Cstruct_s.t;
dh_g : Cstruct_s.t;
dh_Ys : Cstruct_s.t;
dh_p : Cstruct.t;
dh_g : Cstruct.t;
dh_Ys : Cstruct.t;
} with sexp

type ec_curve = {
a : Cstruct_s.t;
b : Cstruct_s.t
a : Cstruct.t;
b : Cstruct.t
} with sexp

type ec_prime_parameters = {
prime : Cstruct_s.t;
prime : Cstruct.t;
curve : ec_curve;
base : Cstruct_s.t;
order : Cstruct_s.t;
cofactor : Cstruct_s.t;
public : Cstruct_s.t
base : Cstruct.t;
order : Cstruct.t;
cofactor : Cstruct.t;
public : Cstruct.t
} with sexp

type ec_char_parameters = {
m : int;
basis : ec_basis_type;
ks : Cstruct_s.t list;
ks : Cstruct.t list;
curve : ec_curve;
base : Cstruct_s.t;
order : Cstruct_s.t;
cofactor : Cstruct_s.t;
public : Cstruct_s.t
base : Cstruct.t;
order : Cstruct.t;
cofactor : Cstruct.t;
public : Cstruct.t
} with sexp

type ec_parameters =
| ExplicitPrimeParameters of ec_prime_parameters
| ExplicitCharParameters of ec_char_parameters
| NamedCurveParameters of (named_curve_type * Cstruct_s.t)
| NamedCurveParameters of (named_curve_type * Cstruct.t)
with sexp

type tls_handshake =
| HelloRequest
| ServerHelloDone
| ClientHello of client_hello
| ServerHello of server_hello
| Certificate of Cstruct_s.t list
| ServerKeyExchange of Cstruct_s.t
| CertificateRequest of Cstruct_s.t
| ClientKeyExchange of Cstruct_s.t
| CertificateVerify of Cstruct_s.t
| Finished of Cstruct_s.t
| Certificate of Cstruct.t list
| ServerKeyExchange of Cstruct.t
| CertificateRequest of Cstruct.t
| ClientKeyExchange of Cstruct.t
| CertificateVerify of Cstruct.t
| Finished of Cstruct.t
with sexp

type tls_alert = alert_level * alert_type
Expand Down
2 changes: 1 addition & 1 deletion lib/engine.ml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@ let new_state config role =
fragment = Cstruct.create 0 ;
}

type raw_record = tls_hdr * Cstruct_s.t with sexp
type raw_record = tls_hdr * Cstruct.t with sexp

(* well-behaved pure encryptor *)
let encrypt (version : tls_version) (st : crypto_state) ty buf =
Expand Down
75 changes: 0 additions & 75 deletions lib/sexp_ext.ml
View file
Open in desktop

This file was deleted.

50 changes: 22 additions & 28 deletions lib/state.ml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,8 @@ type 'k stream_state = {

(* initialisation vector style, depending on TLS version *)
type iv_mode =
| Iv of Cstruct_s.t (* traditional CBC (reusing last cipherblock) *)
| Random_iv (* TLS 1.1 and higher explicit IV (we use random) *)
| Iv of Cstruct.t (* traditional CBC (reusing last cipherblock) *)
| Random_iv (* TLS 1.1 and higher explicit IV (we use random) *)
with sexp
type 'k cbc_cipher = (module Cipher_block.T.CBC with type key = 'k)
type 'k cbc_state = {
Expand All @@ -43,42 +43,36 @@ type cipher_st =
| CBC : 'k cbc_state -> cipher_st
| CCM : 'k ccm_state -> cipher_st

(* context of a TLS connection (both in and out has each one of these) *)
type crypto_context = {
sequence : int64 ; (* sequence number *)
cipher_st : cipher_st ; (* cipher state *)
}

(* Sexplib stubs -- rethink how to play with crypto. *)

let sexp_of_cipher_st = function
| Stream _ -> Sexp.(Atom "<stream-state>")
| CBC _ -> Sexp.(Atom "<cbc-state>")
| CCM _ -> Sexp.(Atom "<ccm-state>")

let crypto_context_of_sexp _ = failwith "can't parse crypto context from sexp"
and sexp_of_crypto_context cc =
Sexp_ext.record [
"sequence" , sexp_of_int64 cc.sequence ;
"cipher_st", sexp_of_cipher_st cc.cipher_st
]

let cipher_st_of_sexp =
Conv.of_sexp_error "cipher_st_of_sexp: not implemented"
Copy link
Copy Markdown
Contributor

@avsm avsm Feb 11, 2015

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

if this is an error, why not just expose only sexp_of below?

Copy link
Copy Markdown
Contributor Author

@pqwy pqwy Feb 12, 2015

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

One, to get downstream types to use with sexp and avoid the boilerplate of writing [one side of] it by hand. Two, because this is expected to be fixed eventually (it's in a (* Sexplib stubs *) ... (* *** *) comment block), and it's nice to have the API, even if sketched out.

Note that all these types should be invisible to the outside. This is all basically for tracing/debugging.

(* *** *)

(* context of a TLS connection (both in and out has each one of these) *)
type crypto_context = {
sequence : int64 ; (* sequence number *)
cipher_st : cipher_st ; (* cipher state *)
} with sexp

(* the raw handshake log we need to carry around *)
type hs_log = Cstruct_s.t list with sexp
type hs_log = Cstruct.t list with sexp
(* the master secret of a TLS connection *)
type master_secret = Cstruct_s.t with sexp
type master_secret = Cstruct.t with sexp
(* diffie hellman group and secret *)
type dh_sent = Dh.group * Dh.secret with sexp

(* a collection of client and server verify bytes for renegotiation *)
type reneg_params = Cstruct_s.t * Cstruct_s.t
type reneg_params = Cstruct.t * Cstruct.t
with sexp

type session_data = {
server_random : Cstruct_s.t ; (* 32 bytes random from the server hello *)
client_random : Cstruct_s.t ; (* 32 bytes random from the client hello *)
server_random : Cstruct.t ; (* 32 bytes random from the server hello *)
client_random : Cstruct.t ; (* 32 bytes random from the client hello *)
client_version : tls_any_version ; (* version in client hello (needed in RSA client key exchange) *)
ciphersuite : Ciphersuite.ciphersuite ;
peer_certificate : X509.t list ;
Expand Down Expand Up @@ -113,10 +107,10 @@ type client_handshake_state =
| AwaitCertificate_RSA of session_data * hs_log (* certificate expected with RSA key exchange *)
| AwaitCertificate_DHE_RSA of session_data * hs_log (* certificate expected with DHE_RSA key exchange *)
| AwaitServerKeyExchange_DHE_RSA of session_data * hs_log (* server key exchange expected with DHE_RSA *)
| AwaitCertificateRequestOrServerHelloDone of session_data * Cstruct_s.t * Cstruct_s.t * hs_log (* server hello done expected, client key exchange and premastersecret are ready *)
| AwaitServerHelloDone of session_data * (Hash.hash * Packet.signature_algorithm_type) list option * Cstruct_s.t * Cstruct_s.t * hs_log (* server hello done expected, client key exchange and premastersecret are ready *)
| AwaitServerChangeCipherSpec of session_data * crypto_context * Cstruct_s.t * hs_log (* change cipher spec expected *)
| AwaitServerFinished of session_data * Cstruct_s.t * hs_log (* finished expected with a hmac over all handshake packets *)
| AwaitCertificateRequestOrServerHelloDone of session_data * Cstruct.t * Cstruct.t * hs_log (* server hello done expected, client key exchange and premastersecret are ready *)
| AwaitServerHelloDone of session_data * (Hash.hash * Packet.signature_algorithm_type) list option * Cstruct.t * Cstruct.t * hs_log (* server hello done expected, client key exchange and premastersecret are ready *)
| AwaitServerChangeCipherSpec of session_data * crypto_context * Cstruct.t * hs_log (* change cipher spec expected *)
| AwaitServerFinished of session_data * Cstruct.t * hs_log (* finished expected with a hmac over all handshake packets *)
| Established (* handshake successfully completed *)
with sexp

Expand All @@ -131,15 +125,15 @@ type handshake_state = {
protocol_version : tls_version ;
machina : handshake_machina_state ; (* state machine state *)
config : Config.config ; (* given config *)
hs_fragment : Cstruct_s.t (* handshake messages can be fragmented, leftover from before *)
hs_fragment : Cstruct.t (* handshake messages can be fragmented, leftover from before *)
} with sexp

(* connection state: initially None, after handshake a crypto context *)
type crypto_state = crypto_context option
with sexp

(* record consisting of a content type and a byte vector *)
type record = Packet.content_type * Cstruct_s.t with sexp
type record = Packet.content_type * Cstruct.t with sexp

(* response returned by a handler *)
type rec_resp = [
Expand All @@ -164,7 +158,7 @@ type state = {
handshake : handshake_state ; (* the current handshake state *)
decryptor : crypto_state ; (* the current decryption state *)
encryptor : crypto_state ; (* the current encryption state *)
fragment : Cstruct_s.t ; (* the leftover fragment from TCP fragmentation *)
fragment : Cstruct.t ; (* the leftover fragment from TCP fragmentation *)
} with sexp

type error = [
Expand Down
3 changes: 1 addition & 2 deletions lib/tls.mlpack
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# OASIS_START
# DO NOT EDIT (digest: 1d66ab051ef4df1447d1c59846d81167)
# DO NOT EDIT (digest: d676bd6a020b72d862191f5554fccfe4)
Tracing
Ciphersuite
Packet
Expand All @@ -10,7 +10,6 @@ Writer
Config
Engine
Control
Sexp_ext
Crypto
Utils
State
Expand Down
2 changes: 1 addition & 1 deletion lib/tracing.ml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,6 @@ let sexpf ~tag ~f x = sexp ~tag @@ lazy (f x)

let sexpfs ~tag ~f xs = if is_tracing () then List.iter (sexpf ~tag ~f) xs

let cs ~tag = sexpf ~tag ~f:Sexp_ext.Cstruct_s.sexp_of_t
let cs ~tag = sexpf ~tag ~f:Cstruct.sexp_of_t

let css ~tag css = if is_tracing () then List.iter (cs ~tag) css
2 changes: 1 addition & 1 deletion opam
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ remove: [ "ocamlfind" "remove" "tls" ]

depends: [
"ocamlfind"
"cstruct" {>= "1.2.0"}
"cstruct" {>= "1.6.0"}
"type_conv"
"sexplib"
"nocrypto" {>= "0.4.0"}
Expand Down
8 changes: 4 additions & 4 deletions setup.ml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
(* setup.ml generated for the first time by OASIS v0.4.4 *)
(* setup.ml generated for the first time by OASIS v0.4.5 *)

(* OASIS_START *)
(* DO NOT EDIT (digest: 87d85e18d17ae7d9c6926bd7d7b8a951) *)
(* DO NOT EDIT (digest: 45395e00447a198f9c66994428f6c6c7) *)
(*
Regenerated by OASIS v0.4.5
Visit http://oasis.forge.ocamlcore.org for more information and
Expand Down Expand Up @@ -6996,7 +6996,6 @@ let setup_t =
lib_internal_modules =
[
"Control";
"Sexp_ext";
"Crypto";
"Utils";
"State";
Expand Down Expand Up @@ -7481,7 +7480,8 @@ let setup_t =
};
oasis_fn = Some "_oasis";
oasis_version = "0.4.5";
oasis_digest = Some "\003\142\227u\205\211V\185-\131B\191P\153\168O";
oasis_digest =
Some "\234P\187\"\029\201\027\253\145\030\212\152h\196\165\242";
oasis_exec = None;
oasis_setup_args = [];
setup_update = false
Expand Down