diff --git a/COPYING.LESSER.md b/COPYING.LESSER.md
new file mode 100644
index 0000000..0927556
--- /dev/null
+++ b/COPYING.LESSER.md
@@ -0,0 +1,157 @@
+### 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/COPYING.md b/COPYING.md
new file mode 100644
index 0000000..2fb2e74
--- /dev/null
+++ b/COPYING.md
@@ -0,0 +1,675 @@
+### GNU 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.
+
+### Preamble
+
+The GNU General Public License is a free, copyleft license for
+software and other kinds of works.
+
+The licenses for most software and other practical works are designed
+to take away your freedom to share and change the works. By contrast,
+the GNU General Public License is intended to guarantee your freedom
+to share and change all versions of a program--to make sure it remains
+free software for all its users. We, the Free Software Foundation, use
+the GNU General Public License for most of our software; it applies
+also to any other work released this way by its authors. You can apply
+it to your programs, too.
+
+When we speak of free software, we are referring to freedom, not
+price. Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+them if you wish), that you receive source code or can get it if you
+want it, that you can change the software or use pieces of it in new
+free programs, and that you know you can do these things.
+
+To protect your rights, we need to prevent others from denying you
+these rights or asking you to surrender the rights. Therefore, you
+have certain responsibilities if you distribute copies of the
+software, or if you modify it: responsibilities to respect the freedom
+of others.
+
+For example, if you distribute copies of such a program, whether
+gratis or for a fee, you must pass on to the recipients the same
+freedoms that you received. You must make sure that they, too, receive
+or can get the source code. And you must show them these terms so they
+know their rights.
+
+Developers that use the GNU GPL protect your rights with two steps:
+(1) assert copyright on the software, and (2) offer you this License
+giving you legal permission to copy, distribute and/or modify it.
+
+For the developers' and authors' protection, the GPL clearly explains
+that there is no warranty for this free software. For both users' and
+authors' sake, the GPL requires that modified versions be marked as
+changed, so that their problems will not be attributed erroneously to
+authors of previous versions.
+
+Some devices are designed to deny users access to install or run
+modified versions of the software inside them, although the
+manufacturer can do so. This is fundamentally incompatible with the
+aim of protecting users' freedom to change the software. The
+systematic pattern of such abuse occurs in the area of products for
+individuals to use, which is precisely where it is most unacceptable.
+Therefore, we have designed this version of the GPL to prohibit the
+practice for those products. If such problems arise substantially in
+other domains, we stand ready to extend this provision to those
+domains in future versions of the GPL, as needed to protect the
+freedom of users.
+
+Finally, every program is threatened constantly by software patents.
+States should not allow patents to restrict development and use of
+software on general-purpose computers, but in those that do, we wish
+to avoid the special danger that patents applied to a free program
+could make it effectively proprietary. To prevent this, the GPL
+assures that patents cannot be used to render the program non-free.
+
+The precise terms and conditions for copying, distribution and
+modification follow.
+
+### TERMS AND CONDITIONS
+
+#### 0. Definitions.
+
+"This License" refers to version 3 of the GNU General Public License.
+
+"Copyright" also means copyright-like laws that apply to other kinds
+of works, such as semiconductor masks.
+
+"The Program" refers to any copyrightable work licensed under this
+License. Each licensee is addressed as "you". "Licensees" and
+"recipients" may be individuals or organizations.
+
+To "modify" a work means to copy from or adapt all or part of the work
+in a fashion requiring copyright permission, other than the making of
+an exact copy. The resulting work is called a "modified version" of
+the earlier work or a work "based on" the earlier work.
+
+A "covered work" means either the unmodified Program or a work based
+on the Program.
+
+To "propagate" a work means to do anything with it that, without
+permission, would make you directly or secondarily liable for
+infringement under applicable copyright law, except executing it on a
+computer or modifying a private copy. Propagation includes copying,
+distribution (with or without modification), making available to the
+public, and in some countries other activities as well.
+
+To "convey" a work means any kind of propagation that enables other
+parties to make or receive copies. Mere interaction with a user
+through a computer network, with no transfer of a copy, is not
+conveying.
+
+An interactive user interface displays "Appropriate Legal Notices" to
+the extent that it includes a convenient and prominently visible
+feature that (1) displays an appropriate copyright notice, and (2)
+tells the user that there is no warranty for the work (except to the
+extent that warranties are provided), that licensees may convey the
+work under this License, and how to view a copy of this License. If
+the interface presents a list of user commands or options, such as a
+menu, a prominent item in the list meets this criterion.
+
+#### 1. Source Code.
+
+The "source code" for a work means the preferred form of the work for
+making modifications to it. "Object code" means any non-source form of
+a work.
+
+A "Standard Interface" means an interface that either is an official
+standard defined by a recognized standards body, or, in the case of
+interfaces specified for a particular programming language, one that
+is widely used among developers working in that language.
+
+The "System Libraries" of an executable work include anything, other
+than the work as a whole, that (a) is included in the normal form of
+packaging a Major Component, but which is not part of that Major
+Component, and (b) serves only to enable use of the work with that
+Major Component, or to implement a Standard Interface for which an
+implementation is available to the public in source code form. A
+"Major Component", in this context, means a major essential component
+(kernel, window system, and so on) of the specific operating system
+(if any) on which the executable work runs, or a compiler used to
+produce the work, or an object code interpreter used to run it.
+
+The "Corresponding Source" for a work in object code form means all
+the source code needed to generate, install, and (for an executable
+work) run the object code and to modify the work, including scripts to
+control those activities. However, it does not include the work's
+System Libraries, or general-purpose tools or generally available free
+programs which are used unmodified in performing those activities but
+which are not part of the work. For example, Corresponding Source
+includes interface definition files associated with source files for
+the work, and the source code for shared libraries and dynamically
+linked subprograms that the work is specifically designed to require,
+such as by intimate data communication or control flow between those
+subprograms and other parts of the work.
+
+The Corresponding Source need not include anything that users can
+regenerate automatically from other parts of the Corresponding Source.
+
+The Corresponding Source for a work in source code form is that same
+work.
+
+#### 2. Basic Permissions.
+
+All rights granted under this License are granted for the term of
+copyright on the Program, and are irrevocable provided the stated
+conditions are met. This License explicitly affirms your unlimited
+permission to run the unmodified Program. The output from running a
+covered work is covered by this License only if the output, given its
+content, constitutes a covered work. This License acknowledges your
+rights of fair use or other equivalent, as provided by copyright law.
+
+You may make, run and propagate covered works that you do not convey,
+without conditions so long as your license otherwise remains in force.
+You may convey covered works to others for the sole purpose of having
+them make modifications exclusively for you, or provide you with
+facilities for running those works, provided that you comply with the
+terms of this License in conveying all material for which you do not
+control copyright. Those thus making or running the covered works for
+you must do so exclusively on your behalf, under your direction and
+control, on terms that prohibit them from making any copies of your
+copyrighted material outside their relationship with you.
+
+Conveying under any other circumstances is permitted solely under the
+conditions stated below. Sublicensing is not allowed; section 10 makes
+it unnecessary.
+
+#### 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
+
+No covered work shall be deemed part of an effective technological
+measure under any applicable law fulfilling obligations under article
+11 of the WIPO copyright treaty adopted on 20 December 1996, or
+similar laws prohibiting or restricting circumvention of such
+measures.
+
+When you convey a covered work, you waive any legal power to forbid
+circumvention of technological measures to the extent such
+circumvention is effected by exercising rights under this License with
+respect to the covered work, and you disclaim any intention to limit
+operation or modification of the work as a means of enforcing, against
+the work's users, your or third parties' legal rights to forbid
+circumvention of technological measures.
+
+#### 4. Conveying Verbatim Copies.
+
+You may convey verbatim copies of the Program's source code as you
+receive it, in any medium, provided that you conspicuously and
+appropriately publish on each copy an appropriate copyright notice;
+keep intact all notices stating that this License and any
+non-permissive terms added in accord with section 7 apply to the code;
+keep intact all notices of the absence of any warranty; and give all
+recipients a copy of this License along with the Program.
+
+You may charge any price or no price for each copy that you convey,
+and you may offer support or warranty protection for a fee.
+
+#### 5. Conveying Modified Source Versions.
+
+You may convey a work based on the Program, or the modifications to
+produce it from the Program, in the form of source code under the
+terms of section 4, provided that you also meet all of these
+conditions:
+
+- a) The work must carry prominent notices stating that you modified
+ it, and giving a relevant date.
+- b) The work must carry prominent notices stating that it is
+ released under this License and any conditions added under
+ section 7. This requirement modifies the requirement in section 4
+ to "keep intact all notices".
+- c) You must license the entire work, as a whole, under this
+ License to anyone who comes into possession of a copy. This
+ License will therefore apply, along with any applicable section 7
+ additional terms, to the whole of the work, and all its parts,
+ regardless of how they are packaged. This License gives no
+ permission to license the work in any other way, but it does not
+ invalidate such permission if you have separately received it.
+- d) If the work has interactive user interfaces, each must display
+ Appropriate Legal Notices; however, if the Program has interactive
+ interfaces that do not display Appropriate Legal Notices, your
+ work need not make them do so.
+
+A compilation of a covered work with other separate and independent
+works, which are not by their nature extensions of the covered work,
+and which are not combined with it such as to form a larger program,
+in or on a volume of a storage or distribution medium, is called an
+"aggregate" if the compilation and its resulting copyright are not
+used to limit the access or legal rights of the compilation's users
+beyond what the individual works permit. Inclusion of a covered work
+in an aggregate does not cause this License to apply to the other
+parts of the aggregate.
+
+#### 6. Conveying Non-Source Forms.
+
+You may convey a covered work in object code form under the terms of
+sections 4 and 5, provided that you also convey the machine-readable
+Corresponding Source under the terms of this License, in one of these
+ways:
+
+- a) Convey the object code in, or embodied in, a physical product
+ (including a physical distribution medium), accompanied by the
+ Corresponding Source fixed on a durable physical medium
+ customarily used for software interchange.
+- b) Convey the object code in, or embodied in, a physical product
+ (including a physical distribution medium), accompanied by a
+ written offer, valid for at least three years and valid for as
+ long as you offer spare parts or customer support for that product
+ model, to give anyone who possesses the object code either (1) a
+ copy of the Corresponding Source for all the software in the
+ product that is covered by this License, on a durable physical
+ medium customarily used for software interchange, for a price no
+ more than your reasonable cost of physically performing this
+ conveying of source, or (2) access to copy the Corresponding
+ Source from a network server at no charge.
+- c) Convey individual copies of the object code with a copy of the
+ written offer to provide the Corresponding Source. This
+ alternative is allowed only occasionally and noncommercially, and
+ only if you received the object code with such an offer, in accord
+ with subsection 6b.
+- d) Convey the object code by offering access from a designated
+ place (gratis or for a charge), and offer equivalent access to the
+ Corresponding Source in the same way through the same place at no
+ further charge. You need not require recipients to copy the
+ Corresponding Source along with the object code. If the place to
+ copy the object code is a network server, the Corresponding Source
+ may be on a different server (operated by you or a third party)
+ that supports equivalent copying facilities, provided you maintain
+ clear directions next to the object code saying where to find the
+ Corresponding Source. Regardless of what server hosts the
+ Corresponding Source, you remain obligated to ensure that it is
+ available for as long as needed to satisfy these requirements.
+- e) Convey the object code using peer-to-peer transmission,
+ provided you inform other peers where the object code and
+ Corresponding Source of the work are being offered to the general
+ public at no charge under subsection 6d.
+
+A separable portion of the object code, whose source code is excluded
+from the Corresponding Source as a System Library, need not be
+included in conveying the object code work.
+
+A "User Product" is either (1) a "consumer product", which means any
+tangible personal property which is normally used for personal,
+family, or household purposes, or (2) anything designed or sold for
+incorporation into a dwelling. In determining whether a product is a
+consumer product, doubtful cases shall be resolved in favor of
+coverage. For a particular product received by a particular user,
+"normally used" refers to a typical or common use of that class of
+product, regardless of the status of the particular user or of the way
+in which the particular user actually uses, or expects or is expected
+to use, the product. A product is a consumer product regardless of
+whether the product has substantial commercial, industrial or
+non-consumer uses, unless such uses represent the only significant
+mode of use of the product.
+
+"Installation Information" for a User Product means any methods,
+procedures, authorization keys, or other information required to
+install and execute modified versions of a covered work in that User
+Product from a modified version of its Corresponding Source. The
+information must suffice to ensure that the continued functioning of
+the modified object code is in no case prevented or interfered with
+solely because modification has been made.
+
+If you convey an object code work under this section in, or with, or
+specifically for use in, a User Product, and the conveying occurs as
+part of a transaction in which the right of possession and use of the
+User Product is transferred to the recipient in perpetuity or for a
+fixed term (regardless of how the transaction is characterized), the
+Corresponding Source conveyed under this section must be accompanied
+by the Installation Information. But this requirement does not apply
+if neither you nor any third party retains the ability to install
+modified object code on the User Product (for example, the work has
+been installed in ROM).
+
+The requirement to provide Installation Information does not include a
+requirement to continue to provide support service, warranty, or
+updates for a work that has been modified or installed by the
+recipient, or for the User Product in which it has been modified or
+installed. Access to a network may be denied when the modification
+itself materially and adversely affects the operation of the network
+or violates the rules and protocols for communication across the
+network.
+
+Corresponding Source conveyed, and Installation Information provided,
+in accord with this section must be in a format that is publicly
+documented (and with an implementation available to the public in
+source code form), and must require no special password or key for
+unpacking, reading or copying.
+
+#### 7. Additional Terms.
+
+"Additional permissions" are terms that supplement the terms of this
+License by making exceptions from one or more of its conditions.
+Additional permissions that are applicable to the entire Program shall
+be treated as though they were included in this License, to the extent
+that they are valid under applicable law. If additional permissions
+apply only to part of the Program, that part may be used separately
+under those permissions, but the entire Program remains governed by
+this License without regard to the additional permissions.
+
+When you convey a copy of a covered work, you may at your option
+remove any additional permissions from that copy, or from any part of
+it. (Additional permissions may be written to require their own
+removal in certain cases when you modify the work.) You may place
+additional permissions on material, added by you to a covered work,
+for which you have or can give appropriate copyright permission.
+
+Notwithstanding any other provision of this License, for material you
+add to a covered work, you may (if authorized by the copyright holders
+of that material) supplement the terms of this License with terms:
+
+- a) Disclaiming warranty or limiting liability differently from the
+ terms of sections 15 and 16 of this License; or
+- b) Requiring preservation of specified reasonable legal notices or
+ author attributions in that material or in the Appropriate Legal
+ Notices displayed by works containing it; or
+- c) Prohibiting misrepresentation of the origin of that material,
+ or requiring that modified versions of such material be marked in
+ reasonable ways as different from the original version; or
+- d) Limiting the use for publicity purposes of names of licensors
+ or authors of the material; or
+- e) Declining to grant rights under trademark law for use of some
+ trade names, trademarks, or service marks; or
+- f) Requiring indemnification of licensors and authors of that
+ material by anyone who conveys the material (or modified versions
+ of it) with contractual assumptions of liability to the recipient,
+ for any liability that these contractual assumptions directly
+ impose on those licensors and authors.
+
+All other non-permissive additional terms are considered "further
+restrictions" within the meaning of section 10. If the Program as you
+received it, or any part of it, contains a notice stating that it is
+governed by this License along with a term that is a further
+restriction, you may remove that term. If a license document contains
+a further restriction but permits relicensing or conveying under this
+License, you may add to a covered work material governed by the terms
+of that license document, provided that the further restriction does
+not survive such relicensing or conveying.
+
+If you add terms to a covered work in accord with this section, you
+must place, in the relevant source files, a statement of the
+additional terms that apply to those files, or a notice indicating
+where to find the applicable terms.
+
+Additional terms, permissive or non-permissive, may be stated in the
+form of a separately written license, or stated as exceptions; the
+above requirements apply either way.
+
+#### 8. Termination.
+
+You may not propagate or modify a covered work except as expressly
+provided under this License. Any attempt otherwise to propagate or
+modify it is void, and will automatically terminate your rights under
+this License (including any patent licenses granted under the third
+paragraph of section 11).
+
+However, if you cease all violation of this License, then your license
+from a particular copyright holder is reinstated (a) provisionally,
+unless and until the copyright holder explicitly and finally
+terminates your license, and (b) permanently, if the copyright holder
+fails to notify you of the violation by some reasonable means prior to
+60 days after the cessation.
+
+Moreover, your license from a particular copyright holder is
+reinstated permanently if the copyright holder notifies you of the
+violation by some reasonable means, this is the first time you have
+received notice of violation of this License (for any work) from that
+copyright holder, and you cure the violation prior to 30 days after
+your receipt of the notice.
+
+Termination of your rights under this section does not terminate the
+licenses of parties who have received copies or rights from you under
+this License. If your rights have been terminated and not permanently
+reinstated, you do not qualify to receive new licenses for the same
+material under section 10.
+
+#### 9. Acceptance Not Required for Having Copies.
+
+You are not required to accept this License in order to receive or run
+a copy of the Program. Ancillary propagation of a covered work
+occurring solely as a consequence of using peer-to-peer transmission
+to receive a copy likewise does not require acceptance. However,
+nothing other than this License grants you permission to propagate or
+modify any covered work. These actions infringe copyright if you do
+not accept this License. Therefore, by modifying or propagating a
+covered work, you indicate your acceptance of this License to do so.
+
+#### 10. Automatic Licensing of Downstream Recipients.
+
+Each time you convey a covered work, the recipient automatically
+receives a license from the original licensors, to run, modify and
+propagate that work, subject to this License. You are not responsible
+for enforcing compliance by third parties with this License.
+
+An "entity transaction" is a transaction transferring control of an
+organization, or substantially all assets of one, or subdividing an
+organization, or merging organizations. If propagation of a covered
+work results from an entity transaction, each party to that
+transaction who receives a copy of the work also receives whatever
+licenses to the work the party's predecessor in interest had or could
+give under the previous paragraph, plus a right to possession of the
+Corresponding Source of the work from the predecessor in interest, if
+the predecessor has it or can get it with reasonable efforts.
+
+You may not impose any further restrictions on the exercise of the
+rights granted or affirmed under this License. For example, you may
+not impose a license fee, royalty, or other charge for exercise of
+rights granted under this License, and you may not initiate litigation
+(including a cross-claim or counterclaim in a lawsuit) alleging that
+any patent claim is infringed by making, using, selling, offering for
+sale, or importing the Program or any portion of it.
+
+#### 11. Patents.
+
+A "contributor" is a copyright holder who authorizes use under this
+License of the Program or a work on which the Program is based. The
+work thus licensed is called the contributor's "contributor version".
+
+A contributor's "essential patent claims" are all patent claims owned
+or controlled by the contributor, whether already acquired or
+hereafter acquired, that would be infringed by some manner, permitted
+by this License, of making, using, or selling its contributor version,
+but do not include claims that would be infringed only as a
+consequence of further modification of the contributor version. For
+purposes of this definition, "control" includes the right to grant
+patent sublicenses in a manner consistent with the requirements of
+this License.
+
+Each contributor grants you a non-exclusive, worldwide, royalty-free
+patent license under the contributor's essential patent claims, to
+make, use, sell, offer for sale, import and otherwise run, modify and
+propagate the contents of its contributor version.
+
+In the following three paragraphs, a "patent license" is any express
+agreement or commitment, however denominated, not to enforce a patent
+(such as an express permission to practice a patent or covenant not to
+sue for patent infringement). To "grant" such a patent license to a
+party means to make such an agreement or commitment not to enforce a
+patent against the party.
+
+If you convey a covered work, knowingly relying on a patent license,
+and the Corresponding Source of the work is not available for anyone
+to copy, free of charge and under the terms of this License, through a
+publicly available network server or other readily accessible means,
+then you must either (1) cause the Corresponding Source to be so
+available, or (2) arrange to deprive yourself of the benefit of the
+patent license for this particular work, or (3) arrange, in a manner
+consistent with the requirements of this License, to extend the patent
+license to downstream recipients. "Knowingly relying" means you have
+actual knowledge that, but for the patent license, your conveying the
+covered work in a country, or your recipient's use of the covered work
+in a country, would infringe one or more identifiable patents in that
+country that you have reason to believe are valid.
+
+If, pursuant to or in connection with a single transaction or
+arrangement, you convey, or propagate by procuring conveyance of, a
+covered work, and grant a patent license to some of the parties
+receiving the covered work authorizing them to use, propagate, modify
+or convey a specific copy of the covered work, then the patent license
+you grant is automatically extended to all recipients of the covered
+work and works based on it.
+
+A patent license is "discriminatory" if it does not include within the
+scope of its coverage, prohibits the exercise of, or is conditioned on
+the non-exercise of one or more of the rights that are specifically
+granted under this License. You may not convey a covered work if you
+are a party to an arrangement with a third party that is in the
+business of distributing software, under which you make payment to the
+third party based on the extent of your activity of conveying the
+work, and under which the third party grants, to any of the parties
+who would receive the covered work from you, a discriminatory patent
+license (a) in connection with copies of the covered work conveyed by
+you (or copies made from those copies), or (b) primarily for and in
+connection with specific products or compilations that contain the
+covered work, unless you entered into that arrangement, or that patent
+license was granted, prior to 28 March 2007.
+
+Nothing in this License shall be construed as excluding or limiting
+any implied license or other defenses to infringement that may
+otherwise be available to you under applicable patent law.
+
+#### 12. No Surrender of Others' Freedom.
+
+If conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License. If you cannot convey a
+covered work so as to satisfy simultaneously your obligations under
+this License and any other pertinent obligations, then as a
+consequence you may not convey it at all. For example, if you agree to
+terms that obligate you to collect a royalty for further conveying
+from those to whom you convey the Program, the only way you could
+satisfy both those terms and this License would be to refrain entirely
+from conveying the Program.
+
+#### 13. Use with the GNU Affero General Public License.
+
+Notwithstanding any other provision of this License, you have
+permission to link or combine any covered work with a work licensed
+under version 3 of the GNU Affero General Public License into a single
+combined work, and to convey the resulting work. The terms of this
+License will continue to apply to the part which is the covered work,
+but the special requirements of the GNU Affero General Public License,
+section 13, concerning interaction through a network will apply to the
+combination as such.
+
+#### 14. Revised Versions of this License.
+
+The Free Software Foundation may publish revised and/or new versions
+of the GNU 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 Program
+specifies that a certain numbered version of the GNU General Public
+License "or any later version" applies to it, you have the option of
+following the terms and conditions either of that numbered version or
+of any later version published by the Free Software Foundation. If the
+Program does not specify a version number of the GNU General Public
+License, you may choose any version ever published by the Free
+Software Foundation.
+
+If the Program specifies that a proxy can decide which future versions
+of the GNU General Public License can be used, that proxy's public
+statement of acceptance of a version permanently authorizes you to
+choose that version for the Program.
+
+Later license versions may give you additional or different
+permissions. However, no additional obligations are imposed on any
+author or copyright holder as a result of your choosing to follow a
+later version.
+
+#### 15. Disclaimer of Warranty.
+
+THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
+APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
+HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT
+WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT
+LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND
+PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE
+DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR
+CORRECTION.
+
+#### 16. Limitation of Liability.
+
+IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR
+CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
+INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES
+ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT
+NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR
+LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM
+TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER
+PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
+
+#### 17. Interpretation of Sections 15 and 16.
+
+If the disclaimer of warranty and limitation of liability provided
+above cannot be given local legal effect according to their terms,
+reviewing courts shall apply local law that most closely approximates
+an absolute waiver of all civil liability in connection with the
+Program, unless a warranty or assumption of liability accompanies a
+copy of the Program in return for a fee.
+
+END OF TERMS AND CONDITIONS
+
+### How to Apply These Terms to Your New Programs
+
+If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these
+terms.
+
+To do so, attach the following notices to the program. It is safest to
+attach them to the start of each source file to most effectively state
+the exclusion of warranty; and each file should have at least the
+"copyright" line and a pointer to where the full notice is found.
+
+ <one line to give the program's name and a brief idea of what it does.>
+ Copyright (C) <year> <name of author>
+
+ This program is free software: you can redistribute it and/or modify
+ it under the terms of the GNU General Public License as published by
+ the Free Software Foundation, either version 3 of the License, or
+ (at your option) any later version.
+
+ This program is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ GNU General Public License for more details.
+
+ You should have received a copy of the GNU General Public License
+ along with this program. If not, see <https://www.gnu.org/licenses/>.
+
+Also add information on how to contact you by electronic and paper
+mail.
+
+If the program does terminal interaction, make it output a short
+notice like this when it starts in an interactive mode:
+
+ <program> Copyright (C) <year> <name of author>
+ This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
+ This is free software, and you are welcome to redistribute it
+ under certain conditions; type `show c' for details.
+
+The hypothetical commands \`show w' and \`show c' should show the
+appropriate parts of the General Public License. Of course, your
+program's commands might be different; for a GUI interface, you would
+use an "about box".
+
+You should also get your employer (if you work as a programmer) or
+school, if any, to sign a "copyright disclaimer" for the program, if
+necessary. For more information on this, and how to apply and follow
+the GNU GPL, see <https://www.gnu.org/licenses/>.
+
+The GNU General Public License does not permit incorporating your
+program into proprietary programs. If your program is a subroutine
+library, you may consider it more useful to permit linking proprietary
+applications with the library. If this is what you want to do, use the
+GNU Lesser General Public License instead of this License. But first,
+please read <https://www.gnu.org/licenses/why-not-lgpl.html>.
diff --git a/src/main/java/com/inteligr8/nio/AbstractBuffer.java b/src/main/java/com/inteligr8/nio/AbstractBuffer.java
index 160124f..d6ad46d 100755
--- a/src/main/java/com/inteligr8/nio/AbstractBuffer.java
+++ b/src/main/java/com/inteligr8/nio/AbstractBuffer.java
@@ -3,9 +3,11 @@ package com.inteligr8.nio;
import java.nio.ByteBuffer;
/**
+ * This class serves as the base for custom multi-part buffer implementations.
+ *
* @author brian@inteligr8.com
*/
-public abstract class AbstractBuffer {
+abstract class AbstractBuffer {
protected long sourceBytesRead = 0L;
protected long targetBytesWritten = 0L;
@@ -20,10 +22,36 @@ public abstract class AbstractBuffer {
else return Status.Uninitialized;
}
+ /**
+ * An accessor for the total number of bytes read from supplied source
+ * buffers.
+ *
+ * The total number of bytes read only indirectly affects the total number
+ * of bytes written. That impact is dictated by the context of the buffer
+ * implementation. If there is caching, writing will appear behind. If
+ * there is padding, writing may appear ahead. It is best to never assume
+ * any predictable relationship between one and the other.
+ *
+ * @return A number of bytes; never negative
+ * @see AbstractBuffer#getTotalBytesWritten()
+ */
public long getTotalBytesRead() {
return this.sourceBytesRead;
}
+ /**
+ * An accessor for the total number of bytes written to supplied target
+ * buffers.
+ *
+ * The total number of bytes written is only indirectly dependent on the
+ * total number of bytes read. That dependency is dictated by the context
+ * of the buffer implementation. If there is caching, writing will appear
+ * behind. If there is padding, writing may appear ahead. It is best to
+ * never assume any predictable relationship between one and the other.
+ *
+ * @return A number of bytes; never negative
+ * @see AbstractBuffer#getTotalBytesRead()
+ */
public long getTotalBytesWritten() {
return this.targetBytesWritten;
}
@@ -35,7 +63,7 @@ public abstract class AbstractBuffer {
*
* @param sourceBuffer A NIO buffer ready for reading
* @param targetBuffer A NIO buffer ready for writing
- * @return The number of bytes transferred
+ * @return The number of bytes transferred; never negative; could be 0
*/
protected int copyBuffer(ByteBuffer sourceBuffer, ByteBuffer targetBuffer) {
int bytesToCopy = Math.min(sourceBuffer.remaining(), targetBuffer.remaining());
diff --git a/src/main/java/com/inteligr8/nio/AbstractCryptoByteChannel.java b/src/main/java/com/inteligr8/nio/AbstractCryptoByteChannel.java
index 1c3c30d..0ea7d66 100644
--- a/src/main/java/com/inteligr8/nio/AbstractCryptoByteChannel.java
+++ b/src/main/java/com/inteligr8/nio/AbstractCryptoByteChannel.java
@@ -31,6 +31,11 @@ public class AbstractCryptoByteChannel implements Channel {
this.channel = channel;
}
+ /**
+ * An accessor for the underlying NIO cipher buffer.
+ *
+ * @return A cipher buffer
+ */
protected CipherBuffer getCipher() {
return this.cipher;
}
@@ -41,6 +46,7 @@ public class AbstractCryptoByteChannel implements Channel {
* by this channel is considered read, but not written.
*
* @return A number of bytes; 0 if not yet read; never negative
+ * @see CipherBuffer#getTotalBytesRead()
*/
public long getTotalBytesRead() {
return this.cipher.getTotalBytesRead();
@@ -52,6 +58,7 @@ public class AbstractCryptoByteChannel implements Channel {
* by this channel is considered read, but not written.
*
* @return A number of bytes; 0 if not yet read; never negative
+ * @see CipherBuffer#getTotalBytesWritten()
*/
public long getTotalBytesWritten() {
return this.cipher.getTotalBytesWritten();
diff --git a/src/main/java/com/inteligr8/nio/AbstractCryptoReadableByteChannel.java b/src/main/java/com/inteligr8/nio/AbstractCryptoReadableByteChannel.java
index e8216ea..9ebabe9 100755
--- a/src/main/java/com/inteligr8/nio/AbstractCryptoReadableByteChannel.java
+++ b/src/main/java/com/inteligr8/nio/AbstractCryptoReadableByteChannel.java
@@ -1,3 +1,17 @@
+/*
+ * This program is free software: you can redistribute it and/or modify it
+ * under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or (at your
+ * option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
+ * more details.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with this program. If not, see <https://www.gnu.org/licenses/>.
+ */
package com.inteligr8.nio;
import java.io.IOException;
diff --git a/src/main/java/com/inteligr8/nio/AbstractCryptoWritableByteChannel.java b/src/main/java/com/inteligr8/nio/AbstractCryptoWritableByteChannel.java
index daa6c7f..bee3b25 100755
--- a/src/main/java/com/inteligr8/nio/AbstractCryptoWritableByteChannel.java
+++ b/src/main/java/com/inteligr8/nio/AbstractCryptoWritableByteChannel.java
@@ -1,3 +1,17 @@
+/*
+ * This program is free software: you can redistribute it and/or modify it
+ * under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or (at your
+ * option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
+ * more details.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with this program. If not, see <https://www.gnu.org/licenses/>.
+ */
package com.inteligr8.nio;
import java.io.Flushable;
diff --git a/src/main/java/com/inteligr8/nio/AbstractDigestByteChannel.java b/src/main/java/com/inteligr8/nio/AbstractDigestByteChannel.java
index 8d5409b..833bc3f 100644
--- a/src/main/java/com/inteligr8/nio/AbstractDigestByteChannel.java
+++ b/src/main/java/com/inteligr8/nio/AbstractDigestByteChannel.java
@@ -1,3 +1,17 @@
+/*
+ * This program is free software: you can redistribute it and/or modify it
+ * under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or (at your
+ * option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
+ * more details.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with this program. If not, see <https://www.gnu.org/licenses/>.
+ */
package com.inteligr8.nio;
import java.io.IOException;
diff --git a/src/main/java/com/inteligr8/nio/CipherBuffer.java b/src/main/java/com/inteligr8/nio/CipherBuffer.java
index 39bfbe3..0b1a6af 100755
--- a/src/main/java/com/inteligr8/nio/CipherBuffer.java
+++ b/src/main/java/com/inteligr8/nio/CipherBuffer.java
@@ -1,3 +1,17 @@
+/*
+ * This program is free software: you can redistribute it and/or modify it
+ * under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or (at your
+ * option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
+ * more details.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with this program. If not, see <https://www.gnu.org/licenses/>.
+ */
package com.inteligr8.nio;
import java.nio.BufferOverflowException;
@@ -21,13 +35,19 @@ import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
- * This class attempts to implement the JCE Cipher using the Java NIO library
- * and concepts. The JCE Cipher accepts ByteBuffer, but it can be complicated
- * to use. This class makes encryption and decryption act more like typical
- * NIO buffer operations.
+ * This class implements the JCE Cipher using the Java NIO library and
+ * concepts. The JCE Cipher accepts ByteBuffer, but it can be complicated to
+ * use. This class makes encryption and decryption act more like typical NIO
+ * buffer operations.
*
* @author brian@inteligr8.com
+ * @see DigestBuffer
+ * @see DecryptingReadableByteChannel
+ * @see EncryptingReadableByteChannel
+ * @see DecryptingWritableByteChannel
+ * @see EncryptingWritableByteChannel
*/
+@PublicApi
public class CipherBuffer extends AbstractBuffer {
private final Logger logger = LoggerFactory.getLogger(CipherBuffer.class);
@@ -104,18 +124,41 @@ public class CipherBuffer extends AbstractBuffer {
this.cipher = cipher;
}
+ /**
+ * An accessor for the JCA key.
+ *
+ * @return A JCA key
+ */
public Key getKey() {
return this.key;
}
+ /**
+ * An accessor for the underlying JCE cipher object.
+ *
+ * @return A JCE cipher
+ */
public Cipher getCipher() {
return this.cipher;
}
+ /**
+ * An accessor for the optional initialization vector.
+ *
+ * @return A byte array of the IV with a length of the key or block size; or null
+ * @see https://en.wikipedia.org/wiki/Initialization_vector
+ */
public byte[] getInitializationVector() {
return this.cipher.getIV();
}
+ /**
+ * A modifier for the optional initialization vector.
+ *
+ * @param initializationVector A byte array of the IV with a length of the key or block size; or null to unset
+ * @throws InvalidAlgorithmParameterException The specified algorithm does not support an IV or the specified length is incorrect
+ * @see https://en.wikipedia.org/wiki/Initialization_vector
+ */
public void setInitializationVector(byte[] initializationVector) throws InvalidAlgorithmParameterException {
try {
if (this.logger.isDebugEnabled())
@@ -129,12 +172,16 @@ public class CipherBuffer extends AbstractBuffer {
/**
* This method flushes any cipher cache, padding, and leftovers into the
- * specified buffer. Any subsequent call to `stream()` will fail.
+ * specified buffer. Any subsequent call to `stream()` will fail. If the
+ * specified buffer is too small, you will need to call this method
+ * multiple times to complete the flush. You should expect to call it
+ * until it returns `false`.
*
* @param targetBuffer A NIO buffer ready for writing
* @return true if more data may need flushed; false if subsequent calls are not expected
- * @throws BadPaddingException
- * @throws IllegalBlockSizeException
+ * @throws BadPaddingException For decryption; an end of stream padding issue occurred; maybe mismatched padding configurations
+ * @throws IllegalBlockSizeException For encryption; the stream likely requires padding
+ * @see CipherBuffer#stream(ByteBuffer, ByteBuffer)
*/
public boolean flush(ByteBuffer targetBuffer) throws BadPaddingException, IllegalBlockSizeException {
if (this.logger.isTraceEnabled())
@@ -183,22 +230,22 @@ public class CipherBuffer extends AbstractBuffer {
/**
* This method streams crypto from a source NIO buffer to a target NIO
* buffer. This differs from the JRE implementation as it is flexible on
- * the size of the target buffer.
+ * the size of the target buffer. You should expect to call this method
+ * until it returns `false`. Afterwards, you will start the `flush`
+ * phase.
*
* @param sourceBuffer A NIO buffer ready for reading
* @param targetBuffer A NIO buffer ready for writing
- * @return true if the source still needs streamed; false if subsequent calls should be flushed
- * @throws BadPaddingException
- * @throws IllegalBlockSizeException
+ * @return true if the source still needs streamed; false if subsequent calls should instead be flushed
+ * @see CipherBuffer#flush(ByteBuffer)
*/
- public boolean stream(ByteBuffer sourceBuffer, ByteBuffer targetBuffer) throws BadPaddingException, IllegalBlockSizeException {
+ public boolean stream(ByteBuffer sourceBuffer, ByteBuffer targetBuffer) {
+ if (sourceBuffer == null)
+ throw new IllegalArgumentException();
+ if (targetBuffer == null)
+ throw new IllegalArgumentException();
if (sourceBuffer != null && this.finished)
throw new IllegalStateException("There should no longer be a source to this cipher");
- if (sourceBuffer == null) {
- this.logger.warn("stream(null, " + targetBuffer.remaining() + "): no source; so flusing");
- this.flush(targetBuffer);
- return false;
- }
if (this.logger.isTraceEnabled())
this.logger.trace("stream(" + sourceBuffer.remaining() + ", " + targetBuffer.remaining() + ")");
diff --git a/src/main/java/com/inteligr8/nio/CipherParameters.java b/src/main/java/com/inteligr8/nio/CipherParameters.java
index 05d3273..1aaf3e3 100755
--- a/src/main/java/com/inteligr8/nio/CipherParameters.java
+++ b/src/main/java/com/inteligr8/nio/CipherParameters.java
@@ -1,14 +1,58 @@
+/*
+ * This program is free software: you can redistribute it and/or modify it
+ * under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or (at your
+ * option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
+ * more details.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with this program. If not, see <https://www.gnu.org/licenses/>.
+ */
package com.inteligr8.nio;
import java.security.Key;
import java.security.Provider;
+/**
+ * This class is a collection of accessors and modifiers for the parameters
+ * used by the cipher classes in this library.
+ *
+ * @author brian@inteligr8.com
+ */
+@PublicApi
public class CipherParameters {
+ /**
+ * A enumeration of the possible sources of initialization vectors.
+ */
+ @PublicApi
public enum IVSource {
+
+ /**
+ * There is not IV expected.
+ */
None,
+
+ /**
+ * The IV intends to be generated automatically. This is only useful
+ * for encryption; not decryption.
+ */
Generated,
+
+ /**
+ * The IV intends to be defined after construction of the class. This
+ * is useful if you will know the IV but you don't know it yet. This
+ * is particularly useful for decryption with embedded IVs.
+ */
Deferred,
+
+ /**
+ * The IV is provided during the construction of the class.
+ */
Provided
}
@@ -20,34 +64,80 @@ public class CipherParameters {
private byte[] iv;
private Provider provider;
+ /**
+ * @param cipherMode Cipher#DECRYPT_MODE or Cipher#ENCRYPT_MODE
+ * @param key A JCA key
+ */
public CipherParameters(int cipherMode, Key key) {
this(cipherMode, key, null, IVSource.None, null, null);
}
-
+
+ /**
+ * @param cipherMode Cipher#DECRYPT_MODE or Cipher#ENCRYPT_MODE
+ * @param key A JCA key
+ * @param transformation A JCE transformation in the pattern 'algorithm/cipher_mode/padding'
+ */
public CipherParameters(int cipherMode, Key key, String transformation) {
this(cipherMode, key, transformation, IVSource.None, null, null);
}
-
+
+ /**
+ * @param cipherMode Cipher#DECRYPT_MODE or Cipher#ENCRYPT_MODE
+ * @param key A JCA key
+ * @param transformation A JCE transformation in the pattern 'algorithm/cipher_mode/padding'
+ * @param ivSource The intended source of the optional IV; use the byte[] for IVSource.Provided
+ */
public CipherParameters(int cipherMode, Key key, String transformation, IVSource ivSource) {
this(cipherMode, key, transformation, ivSource, null, null);
}
-
+
+ /**
+ * @param cipherMode Cipher#DECRYPT_MODE or Cipher#ENCRYPT_MODE
+ * @param key A JCA key
+ * @param transformation A JCE transformation in the pattern 'algorithm/cipher_mode/padding'
+ * @param initializationVector A byte array of the optional IV
+ */
public CipherParameters(int cipherMode, Key key, String transformation, byte[] initializationVector) {
this(cipherMode, key, transformation, IVSource.Provided, initializationVector, null);
}
-
+
+ /**
+ * @param cipherMode Cipher#DECRYPT_MODE or Cipher#ENCRYPT_MODE
+ * @param key A JCA key
+ * @param provider A JCA provider
+ */
public CipherParameters(int cipherMode, Key key, Provider provider) {
this(cipherMode, key, null, IVSource.None, null, provider);
}
-
+
+ /**
+ * @param cipherMode Cipher#DECRYPT_MODE or Cipher#ENCRYPT_MODE
+ * @param key A JCA key
+ * @param transformation A JCE transformation in the pattern 'algorithm/cipher_mode/padding'
+ * @param provider A JCA provider
+ */
public CipherParameters(int cipherMode, Key key, String transformation, Provider provider) {
this(cipherMode, key, transformation, IVSource.None, null, provider);
}
-
+
+ /**
+ * @param cipherMode Cipher#DECRYPT_MODE or Cipher#ENCRYPT_MODE
+ * @param key A JCA key
+ * @param transformation A JCE transformation in the pattern 'algorithm/cipher_mode/padding'
+ * @param ivSource The intended source of the optional IV; use the byte[] for IVSource.Provided
+ * @param provider A JCA provider
+ */
public CipherParameters(int cipherMode, Key key, String transformation, IVSource ivSource, Provider provider) {
this(cipherMode, key, transformation, ivSource, null, provider);
}
-
+
+ /**
+ * @param cipherMode Cipher#DECRYPT_MODE or Cipher#ENCRYPT_MODE
+ * @param key A JCA key
+ * @param transformation A JCE transformation in the pattern 'algorithm/cipher_mode/padding'
+ * @param initializationVector A byte array of the optional IV
+ * @param provider A JCA provider
+ */
public CipherParameters(int cipherMode, Key key, String transformation, byte[] initializationVector, Provider provider) {
this(cipherMode, key, transformation, IVSource.Provided, initializationVector, provider);
}
diff --git a/src/main/java/com/inteligr8/nio/DecryptingCipherParameters.java b/src/main/java/com/inteligr8/nio/DecryptingCipherParameters.java
index 206b16d..60c54ec 100755
--- a/src/main/java/com/inteligr8/nio/DecryptingCipherParameters.java
+++ b/src/main/java/com/inteligr8/nio/DecryptingCipherParameters.java
@@ -1,3 +1,17 @@
+/*
+ * This program is free software: you can redistribute it and/or modify it
+ * under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or (at your
+ * option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
+ * more details.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with this program. If not, see <https://www.gnu.org/licenses/>.
+ */
package com.inteligr8.nio;
import java.security.Key;
@@ -5,47 +19,95 @@ import java.security.Provider;
import javax.crypto.Cipher;
+/**
+ * This class provides a more specific set of constructors and restricted
+ * modifiers for the purposes of delivering parameters to decryptiong classes
+ * in this library.
+ *
+ * @author brian@inteligr8.com
+ */
+@PublicApi
public class DecryptingCipherParameters extends CipherParameters {
+ /**
+ * @param key A JCA key
+ */
public DecryptingCipherParameters(Key key) {
super(Cipher.DECRYPT_MODE, key);
}
-
+
+ /**
+ * @param key A JCA key
+ * @param transformation A JCE transformation in the pattern 'algorithm/cipher_mode/padding'
+ */
public DecryptingCipherParameters(Key key, String transformation) {
super(Cipher.DECRYPT_MODE, key, transformation);
}
-
+
+ /**
+ * @param key A JCA key
+ * @param transformation A JCE transformation in the pattern 'algorithm/cipher_mode/padding'
+ * @param deferInitializationVector The intent to set the IV after construction of this object
+ * @see CipherBuffer#setInitializationVector(byte[])
+ */
public DecryptingCipherParameters(Key key, String transformation, boolean deferInitializationVector) {
super(Cipher.DECRYPT_MODE, key, transformation, deferInitializationVector ? IVSource.Deferred : IVSource.None);
}
-
+
+ /**
+ * @param key A JCA key
+ * @param transformation A JCE transformation in the pattern 'algorithm/cipher_mode/padding'
+ * @param initializationVector A byte array of the optional IV
+ */
public DecryptingCipherParameters(Key key, String transformation, byte[] initializationVector) {
super(Cipher.DECRYPT_MODE, key, transformation, initializationVector);
}
-
+
+ /**
+ * @param key A JCA key
+ * @param provider A JCA provider
+ */
public DecryptingCipherParameters(Key key, Provider provider) {
super(Cipher.DECRYPT_MODE, key, provider);
}
-
+
+ /**
+ * @param key A JCA key
+ * @param transformation A JCE transformation in the pattern 'algorithm/cipher_mode/padding'
+ * @param provider A JCA provider
+ */
public DecryptingCipherParameters(Key key, String transformation, Provider provider) {
super(Cipher.DECRYPT_MODE, key, transformation, provider);
}
-
+
+ /**
+ * @param key A JCA key
+ * @param transformation A JCE transformation in the pattern 'algorithm/cipher_mode/padding'
+ * @param deferInitializationVector The intent to set the IV after construction of this object
+ * @param provider A JCA provider
+ * @see CipherBuffer#setInitializationVector(byte[])
+ */
public DecryptingCipherParameters(Key key, String transformation, boolean deferInitializationVector, Provider provider) {
super(Cipher.DECRYPT_MODE, key, transformation, deferInitializationVector ? IVSource.Deferred : IVSource.None, provider);
}
-
+
+ /**
+ * @param key A JCA key
+ * @param transformation A JCE transformation in the pattern 'algorithm/cipher_mode/padding'
+ * @param initializationVector A byte array of the optional IV
+ * @param provider A JCA provider
+ */
public DecryptingCipherParameters(Key key, String transformation, byte[] initializationVector, Provider provider) {
super(Cipher.DECRYPT_MODE, key, transformation, initializationVector, provider);
}
@Override
- public CipherParameters setCipherMode(int cipherMode) {
+ public final CipherParameters setCipherMode(int cipherMode) {
throw new UnsupportedOperationException();
}
@Override
- public DecryptingCipherParameters setGenerateInitializationVector(boolean generateInitializationVector) {
+ public final DecryptingCipherParameters setGenerateInitializationVector(boolean generateInitializationVector) {
throw new UnsupportedOperationException();
}
diff --git a/src/main/java/com/inteligr8/nio/DecryptingReadableByteChannel.java b/src/main/java/com/inteligr8/nio/DecryptingReadableByteChannel.java
index afdac60..09829c3 100755
--- a/src/main/java/com/inteligr8/nio/DecryptingReadableByteChannel.java
+++ b/src/main/java/com/inteligr8/nio/DecryptingReadableByteChannel.java
@@ -1,3 +1,17 @@
+/*
+ * This program is free software: you can redistribute it and/or modify it
+ * under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or (at your
+ * option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
+ * more details.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with this program. If not, see <https://www.gnu.org/licenses/>.
+ */
package com.inteligr8.nio;
import java.io.IOException;
@@ -11,6 +25,15 @@ import javax.crypto.BadPaddingException;
import javax.crypto.IllegalBlockSizeException;
import javax.crypto.NoSuchPaddingException;
+/**
+ * This class implements a NIO readable byte channel that decrypts the buffers
+ * as it is read from an underlying readable byte channel.
+ *
+ * @author brian@inteligr8.com
+ * @see DecryptingWritableByteChannel
+ * @see EncryptingReadableByteChannel
+ */
+@PublicApi
public class DecryptingReadableByteChannel extends AbstractCryptoReadableByteChannel implements DecryptionMetered {
public DecryptingReadableByteChannel(ReadableByteChannel rbchannel, DecryptingCipherParameters cparams)
@@ -18,11 +41,17 @@ public class DecryptingReadableByteChannel extends AbstractCryptoReadableByteCha
super(rbchannel, cparams);
}
+ /**
+ * @see DecryptionMetered#getEncryptedBytesRead()
+ */
@Override
public long getEncryptedBytesRead() {
return this.getTotalBytesRead();
}
+ /**
+ * @see DecryptionMetered#getDecryptedBytesWritten()
+ */
@Override
public long getDecryptedBytesWritten() {
return this.getTotalBytesWritten();
diff --git a/src/main/java/com/inteligr8/nio/DecryptingWritableByteChannel.java b/src/main/java/com/inteligr8/nio/DecryptingWritableByteChannel.java
index 273b697..00f4cab 100755
--- a/src/main/java/com/inteligr8/nio/DecryptingWritableByteChannel.java
+++ b/src/main/java/com/inteligr8/nio/DecryptingWritableByteChannel.java
@@ -1,3 +1,17 @@
+/*
+ * This program is free software: you can redistribute it and/or modify it
+ * under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or (at your
+ * option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
+ * more details.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with this program. If not, see <https://www.gnu.org/licenses/>.
+ */
package com.inteligr8.nio;
import java.io.IOException;
@@ -11,18 +25,33 @@ import javax.crypto.BadPaddingException;
import javax.crypto.IllegalBlockSizeException;
import javax.crypto.NoSuchPaddingException;
+/**
+ * This class implements a NIO writable byte channel that decrypts the buffers
+ * as it is written to an underlying writable byte channel.
+ *
+ * @author brian@inteligr8.com
+ * @see DecryptingReadableByteChannel
+ * @see EncryptingWritableByteChannel
+ */
+@PublicApi
public class DecryptingWritableByteChannel extends AbstractCryptoWritableByteChannel implements DecryptionMetered {
public DecryptingWritableByteChannel(WritableByteChannel wbchannel, DecryptingCipherParameters cparams)
throws NoSuchAlgorithmException, NoSuchPaddingException, InvalidKeyException, InvalidAlgorithmParameterException {
super(wbchannel, cparams);
}
-
+
+ /**
+ * @see DecryptionMetered#getEncryptedBytesRead()
+ */
@Override
public long getEncryptedBytesRead() {
return this.getTotalBytesRead();
}
-
+
+ /**
+ * @see DecryptionMetered#getDecryptedBytesWritten()
+ */
@Override
public long getDecryptedBytesWritten() {
return this.getTotalBytesWritten();
@@ -35,6 +64,7 @@ public class DecryptingWritableByteChannel extends AbstractCryptoWritableByteCha
* @param buffer A NIO buffer ready for reading
* @return The number of bytes written to the underlying channel; never negative
* @throws IOException An I/O or crypto exception occurred
+ * @see DecryptingWritableByteChannel#flush()
*/
@Override
public int write(ByteBuffer buffer) throws IOException {
@@ -53,6 +83,7 @@ public class DecryptingWritableByteChannel extends AbstractCryptoWritableByteCha
* internal caches and buffers are empty.
*
* @throws IOException An I/O or crypto exception occurred
+ * @see DecryptingWritableByteChannel#write(ByteBuffer)
*/
@Override
public void flush() throws IOException {
diff --git a/src/main/java/com/inteligr8/nio/DecryptionMetered.java b/src/main/java/com/inteligr8/nio/DecryptionMetered.java
index 91ca4b7..594197e 100755
--- a/src/main/java/com/inteligr8/nio/DecryptionMetered.java
+++ b/src/main/java/com/inteligr8/nio/DecryptionMetered.java
@@ -1,8 +1,59 @@
+/*
+ * This program is free software: you can redistribute it and/or modify it
+ * under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or (at your
+ * option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
+ * more details.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with this program. If not, see <https://www.gnu.org/licenses/>.
+ */
package com.inteligr8.nio;
+/**
+ * This interface defines accessors for metered information on the decryption
+ * channels implemented in this library.
+ *
+ * @author brian@inteligr8.com
+ * @see EncryptionMetered
+ */
+@PublicApi
public interface DecryptionMetered {
+ /**
+ * An accessor for the total number of bytes read from encrypted source
+ * buffers or channel.
+ *
+ * The total number of bytes read only indirectly affects the total number
+ * of bytes written. That impact is dictated by the context of the buffer
+ * implementation. If there is caching, writing will appear behind. If
+ * there is padding, writing may appear ahead. It is best to never assume
+ * any predictable relationship between one and the other.
+ *
+ * @return A number of bytes; never negative
+ * @see AbstractBuffer#getTotalBytesRead()
+ * @see DecryptionMetered#getDecryptedBytesWritten()
+ */
long getEncryptedBytesRead();
+
+ /**
+ * An accessor for the total number of bytes written to decrypted target
+ * buffers or channel.
+ *
+ * The total number of bytes written is only indirectly dependent on the
+ * total number of bytes read. That dependency is dictated by the context
+ * of the buffer implementation. If there is caching, writing will appear
+ * behind. If there is padding, writing may appear ahead. It is best to
+ * never assume any predictable relationship between one and the other.
+ *
+ * @return A number of bytes; never negative
+ * @see AbstractBuffer#getTotalBytesWritten()
+ * @see DecryptionMetered#getEncryptedBytesRead()
+ */
long getDecryptedBytesWritten();
}
diff --git a/src/main/java/com/inteligr8/nio/DigestBuffer.java b/src/main/java/com/inteligr8/nio/DigestBuffer.java
index d3482f4..e39e7c1 100755
--- a/src/main/java/com/inteligr8/nio/DigestBuffer.java
+++ b/src/main/java/com/inteligr8/nio/DigestBuffer.java
@@ -1,3 +1,17 @@
+/*
+ * This program is free software: you can redistribute it and/or modify it
+ * under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or (at your
+ * option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
+ * more details.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with this program. If not, see <https://www.gnu.org/licenses/>.
+ */
package com.inteligr8.nio;
import java.nio.ByteBuffer;
@@ -14,7 +28,11 @@ import org.slf4j.LoggerFactory;
* operations.
*
* @author brian@inteligr8.com
+ * @see CipherBuffer
+ * @see HashingReadableByteChannel
+ * @see HashingWritableByteChannel
*/
+@PublicApi
public class DigestBuffer extends AbstractBuffer {
private final Logger logger = LoggerFactory.getLogger(DigestBuffer.class);
@@ -33,16 +51,26 @@ public class DigestBuffer extends AbstractBuffer {
this.leftoverBuffer.flip();
}
+ /**
+ * An accessor for the underlying JCA digest object.
+ *
+ * @return A JCA message digest
+ */
public MessageDigest getMessageDigest() {
return this.digest;
}
/**
* This method flushes the digest cache and buffer into the specified
- * buffer. Any subsequent call to `stream()` will fail.
+ * buffer. Any subsequent call to `stream()` will fail. If the specified
+ * buffer is too small, you will need to call this method multiple times
+ * to complete the flush. You should expect to call it until it returns
+ * `false`.
*
* @param targetBuffer A NIO buffer ready for writing
- * @return true if more data may need flushed; false if subsequent calls will do nothing
+ * @return true if more data may need flushed; false if subsequent calls are not expected
+ * @throws DigestException A hashing issue has occurred
+ * @see DigestBuffer#stream(ByteBuffer)
*/
public boolean flush(ByteBuffer targetBuffer) throws DigestException {
if (this.logger.isTraceEnabled())
@@ -86,10 +114,12 @@ public class DigestBuffer extends AbstractBuffer {
}
/**
- * This method streams the digest from a source NIO buffer to a target NIO
- * buffer.
+ * This method streams hashing from a source NIO buffer to a target NIO
+ * buffer. After streaming all the source, you will start the `flush`
+ * phase.
*
* @param sourceBuffer A NIO buffer ready for reading
+ * @see DigestBuffer#flush(ByteBuffer)
*/
public void stream(ByteBuffer sourceBuffer) {
if (sourceBuffer == null)
diff --git a/src/main/java/com/inteligr8/nio/DigestParameters.java b/src/main/java/com/inteligr8/nio/DigestParameters.java
index dd07645..1285d6d 100755
--- a/src/main/java/com/inteligr8/nio/DigestParameters.java
+++ b/src/main/java/com/inteligr8/nio/DigestParameters.java
@@ -1,16 +1,44 @@
+/*
+ * This program is free software: you can redistribute it and/or modify it
+ * under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or (at your
+ * option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
+ * more details.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with this program. If not, see <https://www.gnu.org/licenses/>.
+ */
package com.inteligr8.nio;
import java.security.Provider;
+/**
+ * This class is a collection of accessors and modifiers for the parameters
+ * used by the message digest classes in this library.
+ *
+ * @author brian@inteligr8.com
+ */
+@PublicApi
public class DigestParameters {
private String algorithm;
private Provider provider;
+ /**
+ * @param algorithm A hashing algorithm
+ */
public DigestParameters(String algorithm) {
this(algorithm, null);
}
+ /**
+ * @param algorithm A hashing algorithm
+ * @param provider A JCA provider
+ */
public DigestParameters(String algorithm, Provider provider) {
this.algorithm = algorithm;
this.provider = provider;
diff --git a/src/main/java/com/inteligr8/nio/EncryptingCipherParameters.java b/src/main/java/com/inteligr8/nio/EncryptingCipherParameters.java
index c865933..e3273e7 100755
--- a/src/main/java/com/inteligr8/nio/EncryptingCipherParameters.java
+++ b/src/main/java/com/inteligr8/nio/EncryptingCipherParameters.java
@@ -1,3 +1,17 @@
+/*
+ * This program is free software: you can redistribute it and/or modify it
+ * under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or (at your
+ * option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
+ * more details.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with this program. If not, see <https://www.gnu.org/licenses/>.
+ */
package com.inteligr8.nio;
import java.security.Key;
@@ -5,42 +19,88 @@ import java.security.Provider;
import javax.crypto.Cipher;
+/**
+ * This class provides a more specific set of constructors and restricted
+ * modifiers for the purposes of delivering parameters to encryptiong classes
+ * in this library.
+ *
+ * @author brian@inteligr8.com
+ */
+@PublicApi
public class EncryptingCipherParameters extends CipherParameters {
-
+
+ /**
+ * @param key A JCA key
+ */
public EncryptingCipherParameters(Key key) {
super(Cipher.ENCRYPT_MODE, key);
}
-
+
+ /**
+ * @param key A JCA key
+ * @param transformation A JCE transformation in the pattern 'algorithm/cipher_mode/padding'
+ */
public EncryptingCipherParameters(Key key, String transformation) {
super(Cipher.ENCRYPT_MODE, key, transformation);
}
-
+
+ /**
+ * @param key A JCA key
+ * @param transformation A JCE transformation in the pattern 'algorithm/cipher_mode/padding'
+ * @param ivSource The intended source of the optional IV; use the byte[] for IVSource.Provided
+ */
public EncryptingCipherParameters(Key key, String transformation, IVSource ivSource) {
super(Cipher.ENCRYPT_MODE, key, transformation, ivSource);
}
-
+
+ /**
+ * @param key A JCA key
+ * @param transformation A JCE transformation in the pattern 'algorithm/cipher_mode/padding'
+ * @param initializationVector A byte array of the optional IV
+ */
public EncryptingCipherParameters(Key key, String transformation, byte[] initializationVector) {
super(Cipher.ENCRYPT_MODE, key, transformation, initializationVector);
}
-
+
+ /**
+ * @param key A JCA key
+ * @param provider A JCA provider
+ */
public EncryptingCipherParameters(Key key, Provider provider) {
super(Cipher.ENCRYPT_MODE, key, provider);
}
-
+
+ /**
+ * @param key A JCA key
+ * @param transformation A JCE transformation in the pattern 'algorithm/cipher_mode/padding'
+ * @param provider A JCA provider
+ */
public EncryptingCipherParameters(Key key, String transformation, Provider provider) {
super(Cipher.ENCRYPT_MODE, key, transformation, provider);
}
-
+
+ /**
+ * @param key A JCA key
+ * @param transformation A JCE transformation in the pattern 'algorithm/cipher_mode/padding'
+ * @param ivSource The intended source of the optional IV; use the byte[] for IVSource.Provided
+ * @param provider A JCA provider
+ */
public EncryptingCipherParameters(Key key, String transformation, IVSource ivSource, Provider provider) {
super(Cipher.ENCRYPT_MODE, key, transformation, ivSource, provider);
}
-
+
+ /**
+ * @param key A JCA key
+ * @param transformation A JCE transformation in the pattern 'algorithm/cipher_mode/padding'
+ * @param initializationVector A byte array of the optional IV
+ * @param provider A JCA provider
+ */
public EncryptingCipherParameters(Key key, String transformation, byte[] initializationVector, Provider provider) {
super(Cipher.ENCRYPT_MODE, key, transformation, initializationVector, provider);
}
@Override
- public CipherParameters setCipherMode(int cipherMode) {
+ public final CipherParameters setCipherMode(int cipherMode) {
throw new UnsupportedOperationException();
}
diff --git a/src/main/java/com/inteligr8/nio/EncryptingReadableByteChannel.java b/src/main/java/com/inteligr8/nio/EncryptingReadableByteChannel.java
index 7fc6e2e..02681e4 100755
--- a/src/main/java/com/inteligr8/nio/EncryptingReadableByteChannel.java
+++ b/src/main/java/com/inteligr8/nio/EncryptingReadableByteChannel.java
@@ -1,3 +1,17 @@
+/*
+ * This program is free software: you can redistribute it and/or modify it
+ * under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or (at your
+ * option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
+ * more details.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with this program. If not, see <https://www.gnu.org/licenses/>.
+ */
package com.inteligr8.nio;
import java.io.IOException;
@@ -11,18 +25,33 @@ import javax.crypto.BadPaddingException;
import javax.crypto.IllegalBlockSizeException;
import javax.crypto.NoSuchPaddingException;
+/**
+ * This class implements a NIO readable byte channel that encrypts the buffers
+ * as it is read from an underlying readable byte channel.
+ *
+ * @author brian@inteligr8.com
+ * @see EncryptingWritableByteChannel
+ * @see DecryptingReadableByteChannel
+ */
+@PublicApi
public class EncryptingReadableByteChannel extends AbstractCryptoReadableByteChannel implements EncryptionMetered {
public EncryptingReadableByteChannel(ReadableByteChannel rbchannel, EncryptingCipherParameters cparams)
throws NoSuchAlgorithmException, NoSuchPaddingException, InvalidKeyException, InvalidAlgorithmParameterException {
super(rbchannel, cparams);
}
-
+
+ /**
+ * @see EncryptionMetered#getDecryptedBytesRead()
+ */
@Override
public long getDecryptedBytesRead() {
return this.getTotalBytesRead();
}
-
+
+ /**
+ * @see EncryptionMetered#getEncryptedBytesWritten()
+ */
@Override
public long getEncryptedBytesWritten() {
return this.getTotalBytesWritten();
diff --git a/src/main/java/com/inteligr8/nio/EncryptingWritableByteChannel.java b/src/main/java/com/inteligr8/nio/EncryptingWritableByteChannel.java
index 402a6d5..9bb66a5 100755
--- a/src/main/java/com/inteligr8/nio/EncryptingWritableByteChannel.java
+++ b/src/main/java/com/inteligr8/nio/EncryptingWritableByteChannel.java
@@ -1,3 +1,17 @@
+/*
+ * This program is free software: you can redistribute it and/or modify it
+ * under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or (at your
+ * option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
+ * more details.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with this program. If not, see <https://www.gnu.org/licenses/>.
+ */
package com.inteligr8.nio;
import java.io.IOException;
@@ -11,18 +25,33 @@ import javax.crypto.BadPaddingException;
import javax.crypto.IllegalBlockSizeException;
import javax.crypto.NoSuchPaddingException;
+/**
+ * This class implements a NIO writable byte channel that encrypts the buffers
+ * as it is written to an underlying writable byte channel.
+ *
+ * @author brian@inteligr8.com
+ * @see EncryptingReadableByteChannel
+ * @see DecryptingWritableByteChannel
+ */
+@PublicApi
public class EncryptingWritableByteChannel extends AbstractCryptoWritableByteChannel implements EncryptionMetered {
public EncryptingWritableByteChannel(WritableByteChannel wbchannel, EncryptingCipherParameters cparams)
throws NoSuchAlgorithmException, NoSuchPaddingException, InvalidKeyException, InvalidAlgorithmParameterException {
super(wbchannel, cparams);
}
-
+
+ /**
+ * @see EncryptionMetered#getDecryptedBytesRead()
+ */
@Override
public long getDecryptedBytesRead() {
return this.getTotalBytesRead();
}
-
+
+ /**
+ * @see EncryptionMetered#getEncryptedBytesWritten()
+ */
@Override
public long getEncryptedBytesWritten() {
return this.getTotalBytesWritten();
@@ -35,6 +64,7 @@ public class EncryptingWritableByteChannel extends AbstractCryptoWritableByteCha
* @param buffer A NIO buffer ready for reading
* @return The number of bytes written to the underlying channel; never negative
* @throws IOException An I/O or crypto exception occurred
+ * @see EncryptingWritableByteChannel#flush()
*/
@Override
public int write(ByteBuffer buffer) throws IOException {
@@ -53,6 +83,7 @@ public class EncryptingWritableByteChannel extends AbstractCryptoWritableByteCha
* internal caches and buffers are empty.
*
* @throws IOException An I/O or crypto exception occurred
+ * @see EncryptingWritableByteChannel#write(ByteBuffer)
*/
@Override
public void flush() throws IOException {
diff --git a/src/main/java/com/inteligr8/nio/EncryptionMetered.java b/src/main/java/com/inteligr8/nio/EncryptionMetered.java
index d7f2906..18dfd4c 100755
--- a/src/main/java/com/inteligr8/nio/EncryptionMetered.java
+++ b/src/main/java/com/inteligr8/nio/EncryptionMetered.java
@@ -1,25 +1,58 @@
+/*
+ * This program is free software: you can redistribute it and/or modify it
+ * under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or (at your
+ * option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
+ * more details.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with this program. If not, see <https://www.gnu.org/licenses/>.
+ */
package com.inteligr8.nio;
+/**
+ * This interface defines accessors for metered information on the encryption
+ * channels implemented in this library.
+ *
+ * @author brian@inteligr8.com
+ * @see DecryptionMetered
+ */
+@PublicApi
public interface EncryptionMetered {
/**
- * The number of bytes read before encryption. The same as the number of
- * bytes read from the underlying channel.
- *
- * When using an embedded IV, this number does NOT include those bytes.
- * This also does NOT include the padding bytes.
- *
- * @return A number of bytes; 0 if not yet read; never negative
+ * An accessor for the total number of bytes read from decrypted source
+ * buffers or channel.
+ *
+ * The total number of bytes read only indirectly affects the total number
+ * of bytes written. That impact is dictated by the context of the buffer
+ * implementation. If there is caching, writing will appear behind. If
+ * there is padding, writing may appear ahead. It is best to never assume
+ * any predictable relationship between one and the other.
+ *
+ * @return A number of bytes; never negative
+ * @see AbstractBuffer#getTotalBytesRead()
+ * @see EncryptionMetered#getEncryptedBytesWritten()
*/
long getDecryptedBytesRead();
/**
- * The number of bytes written after encryption.
- *
- * When using an embedded IV, this number includes those bytes. This also
- * includes the padding bytes.
- *
- * @return A number of bytes; 0 if not yet read; never negative
+ * An accessor for the total number of bytes written to encrypted target
+ * buffers or channel.
+ *
+ * The total number of bytes written is only indirectly dependent on the
+ * total number of bytes read. That dependency is dictated by the context
+ * of the buffer implementation. If there is caching, writing will appear
+ * behind. If there is padding, writing may appear ahead. It is best to
+ * never assume any predictable relationship between one and the other.
+ *
+ * @return A number of bytes; never negative
+ * @see AbstractBuffer#getTotalBytesWritten()
+ * @see EncryptionMetered#getDecryptedBytesRead()
*/
long getEncryptedBytesWritten();
diff --git a/src/main/java/com/inteligr8/nio/HashingReadableByteChannel.java b/src/main/java/com/inteligr8/nio/HashingReadableByteChannel.java
index 810f8da..c7242f5 100644
--- a/src/main/java/com/inteligr8/nio/HashingReadableByteChannel.java
+++ b/src/main/java/com/inteligr8/nio/HashingReadableByteChannel.java
@@ -1,3 +1,17 @@
+/*
+ * This program is free software: you can redistribute it and/or modify it
+ * under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or (at your
+ * option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
+ * more details.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with this program. If not, see <https://www.gnu.org/licenses/>.
+ */
package com.inteligr8.nio;
import java.io.IOException;
@@ -6,6 +20,14 @@ import java.nio.channels.ReadableByteChannel;
import java.security.DigestException;
import java.security.NoSuchAlgorithmException;
+/**
+ * This class implements a NIO readable byte channel that hashes the contents
+ * of the underlying readable byte channel.
+ *
+ * @author brian@inteligr8.com
+ * @see HashingWritableByteChannel
+ */
+@PublicApi
public class HashingReadableByteChannel extends AbstractDigestByteChannel implements ReadableByteChannel {
protected final ReadableByteChannel rbchannel;
@@ -34,10 +56,16 @@ public class HashingReadableByteChannel extends AbstractDigestByteChannel implem
this.readBuffer.flip(); // ready for reading by default
}
+ /**
+ * @see AbstractBuffer#getTotalBytesRead()
+ */
public long getRawBytesRead() {
return this.getTotalBytesRead();
}
+ /**
+ * @see AbstractBuffer#getTotalBytesWritten()
+ */
public long getHashBytesWritten() {
return this.getTotalBytesWritten();
}
@@ -48,7 +76,7 @@ public class HashingReadableByteChannel extends AbstractDigestByteChannel implem
*
* @param buffer A NIO buffer ready for writing
* @return The number of bytes read from the underlying channel; -1 for EOF; 0 is possible and should be re-read
- * @throws IOException An I/O or crypto exception occurred
+ * @throws IOException An I/O exception occurred
*/
@Override
public int read(ByteBuffer buffer) throws IOException {
diff --git a/src/main/java/com/inteligr8/nio/HashingWritableByteChannel.java b/src/main/java/com/inteligr8/nio/HashingWritableByteChannel.java
index ef5d402..af0a08e 100644
--- a/src/main/java/com/inteligr8/nio/HashingWritableByteChannel.java
+++ b/src/main/java/com/inteligr8/nio/HashingWritableByteChannel.java
@@ -1,3 +1,17 @@
+/*
+ * This program is free software: you can redistribute it and/or modify it
+ * under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or (at your
+ * option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
+ * more details.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with this program. If not, see <https://www.gnu.org/licenses/>.
+ */
package com.inteligr8.nio;
import java.io.Flushable;
@@ -10,6 +24,14 @@ import java.security.NoSuchAlgorithmException;
import javax.crypto.BadPaddingException;
import javax.crypto.IllegalBlockSizeException;
+/**
+ * This class implements a NIO writable byte channel that hashes the contents
+ * buffers as they are written to the underlying writable byte channel.
+ *
+ * @author brian@inteligr8.com
+ * @see HashingReadableByteChannel
+ */
+@PublicApi
public class HashingWritableByteChannel extends AbstractDigestByteChannel implements WritableByteChannel, Flushable {
protected final WritableByteChannel wbchannel;
@@ -19,20 +41,27 @@ public class HashingWritableByteChannel extends AbstractDigestByteChannel implem
this.wbchannel = wbchannel;
}
+ /**
+ * @see AbstractBuffer#getTotalBytesRead()
+ */
public long getRawBytesRead() {
return this.getTotalBytesRead();
}
-
+
+ /**
+ * @see AbstractBuffer#getTotalBytesWritten()
+ */
public long getHashBytesWritten() {
return this.getTotalBytesWritten();
}
/**
- * This method hashes to the underlying channel until the specified buffer
- * is empty.
+ * This method hashes the contents of the specified buffer until it is
+ * empty. The hash will not be written to the underlying writable byte
+ * channel until the `flush` phase.
*
* @param buffer A NIO buffer ready for reading
- * @return The number of bytes written to the underlying channel; never negative
+ * @return Always 0
* @throws IOException An I/O or hashing exception occurred
*/
@Override
@@ -44,6 +73,12 @@ public class HashingWritableByteChannel extends AbstractDigestByteChannel implem
}
}
+ /**
+ * This method writes the cached hash to the underlying writable byte
+ * channel.
+ *
+ * @throws IOException An I/O or hashing exception occurred
+ */
@Override
public void flush() throws IOException {
try {
@@ -77,9 +112,8 @@ public class HashingWritableByteChannel extends AbstractDigestByteChannel implem
if (!this.isOpen())
return 0;
- int bytesToWrite = buffer.remaining();
this.getDigest().stream(buffer);
- return bytesToWrite - buffer.remaining();
+ return 0;
}
/**
diff --git a/src/main/java/com/inteligr8/nio/IVDecryptingReadableByteChannel.java b/src/main/java/com/inteligr8/nio/IVDecryptingReadableByteChannel.java
index f04632e..c5024e0 100644
--- a/src/main/java/com/inteligr8/nio/IVDecryptingReadableByteChannel.java
+++ b/src/main/java/com/inteligr8/nio/IVDecryptingReadableByteChannel.java
@@ -1,3 +1,17 @@
+/*
+ * This program is free software: you can redistribute it and/or modify it
+ * under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or (at your
+ * option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
+ * more details.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with this program. If not, see <https://www.gnu.org/licenses/>.
+ */
package com.inteligr8.nio;
import java.io.IOException;
@@ -14,38 +28,68 @@ import javax.crypto.NoSuchPaddingException;
/**
* This class assumes a plain text initialization vector before the start of
* the encrypted content. Otherwise it acts identical to the
- * DecryptingByteChannel.
+ * decrypting readable byte channel.
*
* @author brian@inteligr8.com
+ * @see DecryptingReadableByteChannel
*/
+@PublicApi
public class IVDecryptingReadableByteChannel implements ReadableByteChannel, DecryptionMetered {
private final ReadableByteChannel rbchannel;
private final DecryptingReadableByteChannel drbchannel;
private boolean readIV = false;
+ /**
+ * @param rbchannel A readable byte channel
+ * @param key A JCA key
+ * @param transformation A JCE transformation in the pattern 'algorithm/cipher_mode/padding'
+ * @throws NoSuchAlgorithmException The algorithm is not supported by the JCA provider
+ * @throws NoSuchPaddingException The padding is not supported by the JCA provider and cipher mode
+ * @throws InvalidKeyException The key is not compatible with the specified transformation
+ * @throws InvalidAlgorithmParameterException The algorithm does not support IV or requires an IV
+ */
public IVDecryptingReadableByteChannel(ReadableByteChannel rbchannel, Key key, String transformation)
throws NoSuchAlgorithmException, NoSuchPaddingException, InvalidKeyException, InvalidAlgorithmParameterException {
this.rbchannel = rbchannel;
this.drbchannel = new DecryptingReadableByteChannel(rbchannel, new DecryptingCipherParameters(key, transformation, true));
}
-
+
+ /**
+ * @param rbchannel A readable byte channel
+ * @param key A JCA key
+ * @param transformation A JCE transformation in the pattern 'algorithm/cipher_mode/padding'
+ * @param provider A JCA provider
+ * @throws NoSuchAlgorithmException The algorithm is not supported by the JCA provider
+ * @throws NoSuchPaddingException The padding is not supported by the JCA provider and cipher mode
+ * @throws InvalidKeyException The key is not compatible with the specified transformation
+ * @throws InvalidAlgorithmParameterException The algorithm does not support IV or requires an IV
+ */
public IVDecryptingReadableByteChannel(ReadableByteChannel rbchannel, Key key, String transformation, Provider provider)
throws NoSuchAlgorithmException, NoSuchPaddingException, InvalidKeyException, InvalidAlgorithmParameterException {
this.rbchannel = rbchannel;
this.drbchannel = new DecryptingReadableByteChannel(rbchannel, new DecryptingCipherParameters(key, transformation, true, provider));
}
+ /**
+ * @see DecryptingReadableByteChannel#close()
+ */
@Override
public void close() throws IOException {
this.drbchannel.close();
}
-
+
+ /**
+ * @see DecryptingReadableByteChannel#isOpen()
+ */
@Override
public boolean isOpen() {
return this.drbchannel.isOpen();
}
-
+
+ /**
+ * @see DecryptionMetered#getEncryptedBytesRead()
+ */
@Override
public long getEncryptedBytesRead() {
long bytes = this.drbchannel.getEncryptedBytesRead();
@@ -53,12 +97,24 @@ public class IVDecryptingReadableByteChannel implements ReadableByteChannel, Dec
bytes += this.drbchannel.getCipher().getInitializationVector().length;
return bytes;
}
-
+
+ /**
+ * @see DecryptionMetered#getDecryptedBytesWritten()
+ */
@Override
public long getDecryptedBytesWritten() {
return this.drbchannel.getDecryptedBytesWritten();
}
+ /**
+ * This method will read the IV from the raw readable byte buffer,
+ * configure the cipher to use that IV, and then decrypt the rest of the
+ * readable byte buffer.
+ *
+ * @param buffer A NIO buffer ready for writing
+ * @return The number of bytes read from the underlying channel; -1 for EOF; 0 is possible and should be re-read
+ * @see DecryptingReadableByteChannel#read(ByteBuffer)
+ */
@Override
public int read(ByteBuffer buffer) throws IOException {
int bytes = 0;
diff --git a/src/main/java/com/inteligr8/nio/IVEncryptingWritableByteChannel.java b/src/main/java/com/inteligr8/nio/IVEncryptingWritableByteChannel.java
index 6f9ada9..0425e5a 100644
--- a/src/main/java/com/inteligr8/nio/IVEncryptingWritableByteChannel.java
+++ b/src/main/java/com/inteligr8/nio/IVEncryptingWritableByteChannel.java
@@ -1,3 +1,17 @@
+/*
+ * This program is free software: you can redistribute it and/or modify it
+ * under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or (at your
+ * option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
+ * more details.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with this program. If not, see <https://www.gnu.org/licenses/>.
+ */
package com.inteligr8.nio;
import java.io.Flushable;
@@ -17,16 +31,27 @@ import com.inteligr8.nio.CipherParameters.IVSource;
/**
* This class embeds a random initialization vector at the start of the
* encrypted content. Otherwise it acts identical to the
- * EncryptingByteChannel.
+ * encrypting writable byte channel.
*
* @author brian@inteligr8.com
+ * @see EncryptingWritableByteChannel
*/
+@PublicApi
public class IVEncryptingWritableByteChannel implements WritableByteChannel, Flushable, EncryptionMetered {
private final WritableByteChannel wbchannel;
private final EncryptingWritableByteChannel ewbchannel;
private boolean wroteIV = false;
-
+
+ /**
+ * @param rbchannel A readable byte channel
+ * @param key A JCA key
+ * @param transformation A JCE transformation in the pattern 'algorithm/cipher_mode/padding'
+ * @throws NoSuchAlgorithmException The algorithm is not supported by the JCA provider
+ * @throws NoSuchPaddingException The padding is not supported by the JCA provider and cipher mode
+ * @throws InvalidKeyException The key is not compatible with the specified transformation
+ * @throws InvalidAlgorithmParameterException The algorithm does not support IV or requires an IV
+ */
public IVEncryptingWritableByteChannel(WritableByteChannel wbchannel, Key key, String transformation)
throws NoSuchAlgorithmException, NoSuchPaddingException, InvalidKeyException, InvalidAlgorithmParameterException {
this.wbchannel = wbchannel;
@@ -50,27 +75,42 @@ public class IVEncryptingWritableByteChannel implements WritableByteChannel, Flu
this.wbchannel = wbchannel;
this.ewbchannel = new EncryptingWritableByteChannel(wbchannel, new EncryptingCipherParameters(key, transformation, iv, provider));
}
-
+
+ /**
+ * @see EncryptingWritableByteChannel#close()
+ */
@Override
public void close() throws IOException {
this.ewbchannel.close();
}
-
+
+ /**
+ * @see EncryptingWritableByteChannel#isOpen()
+ */
@Override
public boolean isOpen() {
return this.ewbchannel.isOpen();
}
+ /**
+ * @see EncryptingWritableByteChannel#flush()
+ */
@Override
public void flush() throws IOException {
this.ewbchannel.flush();
}
-
+
+ /**
+ * @see EncryptionMetered#getDecryptedBytesRead()
+ */
@Override
public long getDecryptedBytesRead() {
return this.ewbchannel.getDecryptedBytesRead();
}
-
+
+ /**
+ * @see EncryptionMetered#getEncryptedBytesWritten()
+ */
@Override
public long getEncryptedBytesWritten() {
long bytes = this.ewbchannel.getEncryptedBytesWritten();
@@ -78,7 +118,16 @@ public class IVEncryptingWritableByteChannel implements WritableByteChannel, Flu
bytes += this.ewbchannel.getCipher().getInitializationVector().length;
return bytes;
}
-
+
+ /**
+ * This method will write the configured or generated IV to the raw
+ * writable byte buffer, configure the cipher to use that IV, and then
+ * encrypt the rest of the writable byte buffer.
+ *
+ * @param buffer A NIO buffer ready for reading
+ * @return The number of bytes written to the underlying channel; 0 is possible
+ * @see EncryptingWritableByteChannel#write(ByteBuffer)
+ */
@Override
public int write(ByteBuffer src) throws IOException {
int bytes = 0;
diff --git a/src/main/java/com/inteligr8/nio/PublicApi.java b/src/main/java/com/inteligr8/nio/PublicApi.java
new file mode 100644
index 0000000..2ec54df
--- /dev/null
+++ b/src/main/java/com/inteligr8/nio/PublicApi.java
@@ -0,0 +1,25 @@
+/*
+ * This program is free software: you can redistribute it and/or modify it
+ * under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or (at your
+ * option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
+ * more details.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with this program. If not, see <https://www.gnu.org/licenses/>.
+ */
+package com.inteligr8.nio;
+
+import java.lang.annotation.Documented;
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Target;
+
+@Documented
+@Target({ElementType.TYPE, ElementType.METHOD})
+public @interface PublicApi {
+
+}
diff --git a/src/main/java/com/inteligr8/nio/Status.java b/src/main/java/com/inteligr8/nio/Status.java
index ecf8254..b57eb6a 100755
--- a/src/main/java/com/inteligr8/nio/Status.java
+++ b/src/main/java/com/inteligr8/nio/Status.java
@@ -1,5 +1,27 @@
+/*
+ * This program is free software: you can redistribute it and/or modify it
+ * under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or (at your
+ * option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
+ * more details.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with this program. If not, see <https://www.gnu.org/licenses/>.
+ */
package com.inteligr8.nio;
+/**
+ * This enum defines the set of possible status values for a multi-part buffer.
+ * Each value is meant to be self-explanatory, but rely on the context of their
+ * use.
+ *
+ * @author brian@inteligr8.com
+ */
+@PublicApi
public enum Status {
Uninitialized,