1  # SPDX-FileCopyrightText: 2024 Le'Sec liboqs plugin collective
 2  #
 3  # SPDX-License-Identifier: LGPL-3.0-or-later
 4  
 5  #+TITLE: A plugin for liboqs
 6  #+OPTIONS author:nil data:nil
 7  #+LANGUAGE: en
 8  
 9  
10  liboqs is a research library of PQC algorithms.  Its API is extremely easy to
11  understand, and whould therefore be easy to wrap into a plugin.  It includes
12  algorithms that have been standardised by now, like ML-KEM and ML-DSA.
13  
14  This project wraps liboqs with plugin code to be used and interfaced with by
15  applications that use the [[https://forge.le-pri.me/le/Le-Sec-core][Le'Sec Core library]] (or higher level application
16  libraries that depend on it).
17  
18  As a proof of concept, it is built with as few dependencies as possible.
19  Most centrally, it depends on the Le'Sec Core[fn:Le'Sec-Core] libraries and
20  their dependencies, as well as the Le'Sec Plugin[fn:Le'Sec-Plugin] library.
21  And of course, it depends on liboqs.  But that's basically it.
22  
23  For testing, the tools from the Le'Sec application library[fn:Le'Sec] is also
24  needed.
25  
26  To build, test and install this project, see [[file:INSTALL.org][INSTALL.org]].
27  
28  [fn:Le'Sec-Core] https://seed.le-pri.me/rad:zhC8FYTgZt9JzGR9XHJvkU8Jdc5z,
29  or =rad:zhC8FYTgZt9JzGR9XHJvkU8Jdc5z= on the [[https://radicle.xyz][Radicle]] network.
30  [fn:Le'Sec-Plugin] https://seed.le-pri.me/rad:z4VZKQASFDzgMVF8Zis5ztJCZV3KR,
31  or =rad:z4VZKQASFDzgMVF8Zis5ztJCZV3KR= on the [[https://radicle.xyz][Radicle]] network.
32  [fn:Le'Sec] https://seed.le-pri.me/rad:zDHDLNuSR9VAHAuDxyGitxs8AWLE,
33  or =rad:zDHDLNuSR9VAHAuDxyGitxs8AWLE= on the [[https://radicle.xyz][Radicle]] network.
34  
35  * Distribution
36  
37  The license of this project is [[file:LICENSES/LGPL-3.0-or-later.txt][the Lesser GNU Public License, 3.0 or later]].
38  Some individual files may be licensed with a different but compatible license.
39  
40  Please see the files themselves, or in some cases [[file:REUSE.toml][REUSE.toml]], to find out
41  what license govern each of them in particular.  Please see the [[file:LICENSES/][LICENSES]]
42  subdirectory to study the licenses themselves if they aren't in full in the
43  files themselves.
44  
45  Project contributors who wish to be named are listed in [[file:COLLECTIVE.org][COLLECTIVE.org]].