add readme and license text

7 files changed, 196 insertions, 2 deletions

diff --git a/COPYING b/COPYING
new file mode 100644
index 0000000..0a04128
--- /dev/null
+++ b/COPYING
@@ -0,0 +1,165 @@
+                   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.
diff --git a/readme.rst b/readme.rst
new file mode 100644
index 0000000..4a95f48
--- /dev/null
+++ b/readme.rst
@@ -0,0 +1,19 @@
+synopsis
+--------
+Library routines for handling Microsoft Security Identifiers in text and binary
+format.
+
+Includes a utility ``sidparse`` for dissecting SIDs on the command line.
+
+references
+----------
+SIDs are specified in MS-DTYP_.
+
+.. _MS-DTYP: https://msdn.microsoft.com/en-us/library/cc230273.aspx
+
+license
+-------
+This package is licensed_ as ``LGPL-3.0-only`` (no “any later version” clause).
+
+.. _licensed: https://spdx.org/licenses/LGPL-3.0-only.html
+
diff --git a/sid.ml b/sid.ml
index ece361d..430393d 100644
--- a/sid.ml
+++ b/sid.ml
@@ -1,3 +1,5 @@
+(* SPDX-License-Identifier: LGPL-3.0-only *)
+
 module U64 = Stdint.Uint64
 module U32 = Stdint.Uint32
 
diff --git a/sid.mli b/sid.mli
index f7fcbec..23c4a71 100644
--- a/sid.mli
+++ b/sid.mli
@@ -1,3 +1,5 @@
+(* SPDX-License-Identifier: LGPL-3.0-only *)
+
 type t
 type sub_auths = Stdint.Uint32.t array
 val create_unsafe : Stdint.Uint32.t array -> Stdint.Uint64.t -> t
diff --git a/sid.opam b/sid.opam
index c0e9507..d417760 100644
--- a/sid.opam
+++ b/sid.opam
@@ -3,8 +3,10 @@ version: "0"
 synopsis: "Handle security identfiers"
 
 maintainer: "Philipp Gesang <phg@phi-gamma.net>"
+bug-reports: "https://gitlab.com/phgsng/ocaml-sid"
+homepage: "https://gitlab.com/phgsng/ocaml-sid"
 authors: [ "Philipp Gesang" ]
-license: "LGPLv3"
+license: "LGPL-3.0-only"
 depends: [
   "ocamlbuild" {build}
   "oasis" {build}
@@ -17,4 +19,4 @@ build: [
   ["ocaml" "setup.ml" "-build"]
 ]
 install: [make "install"]
-build-test: [make "test"]
+run-test: [make "test"]
diff --git a/util/sidparse.ml b/util/sidparse.ml
index e99d27f..5ab6bf4 100644
--- a/util/sidparse.ml
+++ b/util/sidparse.ml
@@ -1,3 +1,5 @@
+(* SPDX-License-Identifier: LGPL-3.0-only *)
+
 let err q v =
   match q, v with
     | true, _ -> Printf.ifprintf stdout
diff --git a/xxd.ml b/xxd.ml
index 7d3ab16..5c3bad9 100644
--- a/xxd.ml
+++ b/xxd.ml
@@ -1,3 +1,5 @@
+(* SPDX-License-Identifier: LGPL-3.0-only *)
+
 let (!!) = Bytes.unsafe_of_string
 let (??) = Bytes.unsafe_to_string