aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
Diffstat
-rw-r--r--doc/news.rst3
-rw-r--r--readme.rst9
-rw-r--r--src/ocaml/botan.ml189
-rw-r--r--src/ocaml/botan.mli38
-rwxr-xr-xsrc/ocaml/build.sh6
5 files changed, 8 insertions, 237 deletions
diff --git a/doc/news.rst b/doc/news.rst
index 8af76bf2a..063b1fe91 100644
--- a/doc/news.rst
+++ b/doc/news.rst
@@ -4,6 +4,9 @@ Release Notes
Version 1.11.21, Not Yet Released
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+* The OCaml module is now a separate project at
+ https://github.com/randombit/botan-ocaml
+
Version 1.11.20, 2015-09-07
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
diff --git a/readme.rst b/readme.rst
index 693b31297..ca52b88e9 100644
--- a/readme.rst
+++ b/readme.rst
@@ -42,10 +42,11 @@ The `GitHub wiki <https://github.com/randombit/botan/wiki>`_
and `Doxygen docs <https://botan.randombit.net/doxygen>`_
may also prove useful resources.
-In addition to C++ there are (partial, in-progress) bindings for C89,
-Python and OCaml included along with the library, and
-`Node.js <https://github.com/justinfreitag/node-botan>`_ wrapper also
-exists.
+In addition to C++, botan has a C89 API specifically designed to be easy
+to call from other languages. A Python binding using ctypes is included,
+there are also bindings for
+`Node.js <https://github.com/justinfreitag/node-botan>`_ and
+`OCaml <https://github.com/randombit/botan-ocaml>`_
There is also a third party open source implementation of
`SSHv2 <https://github.com/cdesjardins/cppssh>`_ using the library.
diff --git a/src/ocaml/botan.ml b/src/ocaml/botan.ml
deleted file mode 100644
index 091f44c27..000000000
--- a/src/ocaml/botan.ml
+++ /dev/null
@@ -1,189 +0,0 @@
-(*
-* OCaml binding for botan (http://botan.randombit.net)
-* (C) 2015 Jack Lloyd
-*
-* Botan is released under the Simplified BSD License (see license.txt)
-*)
-
-open Ctypes
-open Foreign
-
-exception Botan_Error of int
-
-(* TODO: translate error code to string
-TODO: Don't evaluate res unless rc == 0
-*)
-let result_or_exn rc res =
- match rc with
- | 0 -> res
- | _ as ec -> raise (Botan_Error ec)
-
-let to_size_t i = Unsigned.Size_t.of_int i
-let to_uint32 i = Unsigned.UInt32.of_int i
-
-module Botan = struct
-
- let version =
- let version_major =
- foreign "botan_version_major" (void @-> returning int32_t) in
- let version_minor =
- foreign "botan_version_minor" (void @-> returning int32_t) in
- let version_patch =
- foreign "botan_version_patch" (void @-> returning int32_t) in
- let major = Int32.to_int (version_major ()) in
- let minor = Int32.to_int (version_minor ()) in
- let patch = Int32.to_int (version_patch ()) in
- (major, minor, patch)
-
- let version_string =
- let version_string =
- foreign "botan_version_string" (void @-> returning string) in
- version_string ()
-
- let version_date =
- let version_datestamp =
- foreign "botan_version_datestamp" (void @-> returning int32_t) in
- Int32.to_int (version_datestamp ())
-
- let ffi_version =
- let ffi_version =
- foreign "botan_ffi_api_version" (void @-> returning int32_t) in
- Int32.to_int (ffi_version ())
-
- let hex_encode bin =
- let hex_encode =
- foreign "botan_hex_encode" (string @-> size_t @-> ptr char @-> uint32_t @-> returning int) in
- let bin_len = String.length bin in
- let hex_len = 2*bin_len in
- let hex = allocate_n ~count:hex_len char in
- let rc = hex_encode bin (to_size_t bin_len) hex (to_uint32 0) in
- result_or_exn rc (string_from_ptr hex hex_len)
-
- (* Bcrypt *)
- let bcrypt pass rng work_factor =
- let bcrypt =
- foreign "botan_bcrypt_generate" (ptr char @-> ptr size_t @->
- string @-> ptr void @-> size_t @-> uint32_t @-> returning int) in
- let bcrypt_size = 61 (* FIXME *) in
- let alloc_size = allocate size_t (to_size_t bcrypt_size) in
- let res = allocate_n ~count:bcrypt_size char in
- let rc = bcrypt res alloc_size pass rng (to_size_t work_factor) (to_uint32 0) in
- result_or_exn rc (string_from_ptr res (Unsigned.Size_t.to_int (!@ alloc_size)))
-
- let check_bcrypt pass hash =
- let check_bcrypt =
- foreign "botan_bcrypt_is_valid" (string @-> string @-> returning int) in
- let rc = check_bcrypt pass hash in
- match rc with
- | 0 -> true
- | -100 -> false
- | _ as ec -> raise (Botan_Error ec)
-
- module Hash = struct
- type t = unit ptr
- let hash_t : t typ = ptr void
-
- let create name =
- let hash_init =
- foreign "botan_hash_init" (ptr hash_t @-> string @-> uint32_t @-> returning int) in
- let o = allocate_n ~count:1 hash_t in
- let rc = hash_init o name (to_uint32 0) in
- result_or_exn rc (!@ o)
-
- let destroy hash =
- let hash_destroy =
- foreign "botan_hash_destroy" (hash_t @-> returning int) in
- let rc = hash_destroy hash in
- result_or_exn rc ()
-
- let output_length hash =
- let hash_output_length =
- foreign "botan_hash_output_length" (hash_t @-> ptr size_t @-> returning int) in
- let ol = allocate_n ~count:1 size_t in
- let rc = hash_output_length hash ol in
- result_or_exn rc (Unsigned.Size_t.to_int (!@ ol))
-
- let clear hash =
- let hash_clear =
- foreign "botan_hash_clear" (hash_t @-> returning int) in
- let rc = hash_clear hash in
- result_or_exn rc ()
-
- let update hash input =
- let hash_update =
- foreign "botan_hash_update" (hash_t @-> string @-> size_t @-> returning int) in
- let input_len = (String.length input) in
- let rc = hash_update hash input (to_size_t input_len) in
- result_or_exn rc ()
-
- let final hash =
- let hash_final =
- foreign "botan_hash_final" (hash_t @-> ptr char @-> returning int) in
- let ol = output_length hash in
- let res = allocate_n ~count:ol char in
- let rc = hash_final hash res in
- result_or_exn rc (string_from_ptr res ol)
-
- end (* Hash *)
-
- module RNG = struct
- type t = unit ptr
- let rng_t : t typ = ptr void
-
- let create name =
- let rng_init =
- foreign "botan_rng_init" (ptr rng_t @-> string @-> uint32_t @-> returning int) in
- let o = allocate_n ~count:1 rng_t in
- let rc = rng_init o name (to_uint32 0) in
- result_or_exn rc (!@ o)
-
- let destroy rng =
- let rng_destroy =
- foreign "botan_rng_destroy" (rng_t @-> returning int) in
- let rc = rng_destroy rng in
- result_or_exn rc ()
-
- let generate rng out_len =
- let rng_generate =
- foreign "botan_rng_get" (rng_t @-> ptr char @-> size_t @-> returning int) in
- let res = allocate_n ~count:out_len char in
- let rc = rng_generate rng res (to_size_t out_len) in
- result_or_exn rc (string_from_ptr res out_len)
-
- let reseed rng bits =
- let rng_reseed =
- foreign "botan_rng_reseed" (rng_t @-> size_t @-> returning int) in
- let rc = rng_reseed rng (to_size_t bits) in
-
- result_or_exn rc ()
-
- let update rng input =
- let rng_update =
- foreign "botan_rng_update" (rng_t @-> string @-> size_t @-> returning int) in
- let input_len = (String.length input) in
- let rc = rng_update rng input (to_size_t input_len) in
- result_or_exn rc ()
-
- end (* RNG *)
-
-end (* Botan *)
-
-let () =
- let rng = Botan.RNG.create "system" in
- let bcrypt = Botan.bcrypt "pass" rng 10 in
- let ok = Botan.check_bcrypt "pass" bcrypt in
- let nok = Botan.check_bcrypt "something else" bcrypt in
- print_string (Printf.sprintf "%s %B %B\n" bcrypt ok nok)
-
-let () =
- let (maj,min,patch) = Botan.version in
- let ver_str = Botan.version_string in
- print_string (Printf.sprintf "%d.%d.%d\n%s\n" maj min patch ver_str)
-
-let () =
- let h = Botan.Hash.create "SHA-384" in
- begin
- Botan.Hash.update h "hi";
- print_string (Botan.hex_encode (Botan.Hash.final h) ^ "\n");
- Botan.Hash.destroy h
- end
diff --git a/src/ocaml/botan.mli b/src/ocaml/botan.mli
deleted file mode 100644
index 0407177bb..000000000
--- a/src/ocaml/botan.mli
+++ /dev/null
@@ -1,38 +0,0 @@
-(*
-* OCaml binding for botan (http://botan.randombit.net)
-* (C) 2015 Jack Lloyd
-*
-* Botan is released under the Simplified BSD License (see license.txt)
-*)
-
-
-module Botan : sig
- val version : (int * int * int)
- val version_string : string
- val version_date : int
- val ffi_version : int
-
- val hex_encode : string -> string
-
- module RNG : sig
- type t
- val create : string -> t
- val destroy: t -> unit (* TODO: GC finalize instead *)
- val generate : t -> int -> string
- val reseed : t -> int -> unit
- end
-
- val bcrypt : string -> RNG.t -> int -> string
- val check_bcrypt : string -> string -> bool
-
- module Hash : sig
- type t
- val create : string -> t
- val destroy: t -> unit (* TODO: GC finalize instead *)
- val output_length : t -> int
- val clear : t -> unit
- val update : t -> string -> unit
- val final: t -> string
- end
-
-end
diff --git a/src/ocaml/build.sh b/src/ocaml/build.sh
deleted file mode 100755
index a79f7d6ac..000000000
--- a/src/ocaml/build.sh
+++ /dev/null
@@ -1,6 +0,0 @@
-#!/bin/sh
-set -e
-which shellcheck > /dev/null && shellcheck "$0" # Run shellcheck on this if available
-
-# extra ../ is needed due to ocamlbuild chdiring into _build
-ocamlbuild -pkg ctypes.foreign -lflags -cclib,-L../../.. -lflags -cclib,-lbotan-1.11 botan.native
generated by cgit v1.2.3 (git 2.39.1) at 2024-12-21 01:16:46 +0000