From 635804e2663007be9323bae4626b90195c41e8e4 Mon Sep 17 00:00:00 2001 From: "Aode (lion)" Date: Mon, 29 Nov 2021 21:38:25 -0600 Subject: [PATCH] Improve documentation, organization --- Cargo.toml | 23 +- LICENSE | 661 +++++++++++++++++++ apub-awc/src/lib.rs | 2 +- apub-background-jobs/src/lib.rs | 39 +- apub-core/src/session.rs | 4 - apub-reqwest/src/lib.rs | 2 +- examples/actix-web-example/src/main.rs | 37 +- examples/awc-example/src/main.rs | 6 +- examples/background-jobs-example/src/main.rs | 13 +- examples/example-types/src/lib.rs | 8 +- examples/reqwest-example/src/main.rs | 6 +- src/lib.rs | 276 ++++++-- 12 files changed, 959 insertions(+), 118 deletions(-) create mode 100644 LICENSE diff --git a/Cargo.toml b/Cargo.toml index e7160d9..a285653 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,19 +1,37 @@ [package] name = "apub" +description = "Utilities for building activitypub servers" version = "0.1.0" +license = "AGPL-3.0" +authors = ["asonix "] +repository = "https://git.asonix.dog/asonix/apub" +keywords = ["activitypub", "activitystreams", "federation", "async"] edition = "2021" # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html [features] default = ["utils"] +full = [ + "with-actix-web", + "with-awc", + "with-background-jobs", + "with-openssl", + "with-rustcrypto", + "utils" +] with-actix-web = ["apub-actix-web"] with-awc = ["apub-awc"] with-background-jobs = ["apub-background-jobs"] with-openssl = ["apub-openssl"] with-reqwest = ["apub-reqwest"] with-rustcrypto = ["apub-rustcrypto"] -utils = ["apub-breaker-session", "apub-ingest", "apub-publickey", "apub-simple-activitypub"] +utils = [ + "apub-breaker-session", + "apub-ingest", + "apub-publickey", + "apub-simple-activitypub" +] [dependencies] apub-actix-web = { version = "0.1.0", path = "./apub-actix-web/", optional = true } @@ -59,3 +77,6 @@ members = [ "examples/example-types", "examples/reqwest-example" ] + +[package.metadata.docs.rs] +all-features = true diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..0ad25db --- /dev/null +++ b/LICENSE @@ -0,0 +1,661 @@ + GNU AFFERO GENERAL PUBLIC LICENSE + Version 3, 19 November 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU Affero General Public License is a free, copyleft license for +software and other kinds of works, specifically designed to ensure +cooperation with the community in the case of network server software. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +our General Public Licenses are 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. + + 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. + + Developers that use our General Public Licenses protect your rights +with two steps: (1) assert copyright on the software, and (2) offer +you this License which gives you legal permission to copy, distribute +and/or modify the software. + + A secondary benefit of defending all users' freedom is that +improvements made in alternate versions of the program, if they +receive widespread use, become available for other developers to +incorporate. Many developers of free software are heartened and +encouraged by the resulting cooperation. However, in the case of +software used on network servers, this result may fail to come about. +The GNU General Public License permits making a modified version and +letting the public access it on a server without ever releasing its +source code to the public. + + The GNU Affero General Public License is designed specifically to +ensure that, in such cases, the modified source code becomes available +to the community. It requires the operator of a network server to +provide the source code of the modified version running there to the +users of that server. Therefore, public use of a modified version, on +a publicly accessible server, gives the public access to the source +code of the modified version. + + An older license, called the Affero General Public License and +published by Affero, was designed to accomplish similar goals. This is +a different license, not a version of the Affero GPL, but Affero has +released a new version of the Affero GPL which permits relicensing under +this license. + + 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 Affero 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. Remote Network Interaction; Use with the GNU General Public License. + + Notwithstanding any other provision of this License, if you modify the +Program, your modified version must prominently offer all users +interacting with it remotely through a computer network (if your version +supports such interaction) an opportunity to receive the Corresponding +Source of your version by providing access to the Corresponding Source +from a network server at no charge, through some standard or customary +means of facilitating copying of software. This Corresponding Source +shall include the Corresponding Source for any work covered by version 3 +of the GNU General Public License that is incorporated pursuant to the +following paragraph. + + 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 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 work with which it is combined will remain governed by version +3 of the GNU General Public License. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU Affero 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 Affero 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 Affero 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 Affero 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. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU Affero 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 Affero General Public License for more details. + + You should have received a copy of the GNU Affero General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If your software can interact with users remotely through a computer +network, you should also make sure that it provides a way for users to +get its source. For example, if your program is a web application, its +interface could display a "Source" link that leads users to an archive +of the code. There are many ways you could offer source, and different +solutions will be better for different programs; see section 13 for the +specific requirements. + + 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 AGPL, see +. diff --git a/apub-awc/src/lib.rs b/apub-awc/src/lib.rs index 6d74084..4fc56df 100644 --- a/apub-awc/src/lib.rs +++ b/apub-awc/src/lib.rs @@ -24,7 +24,7 @@ pub use http_signature_normalization_actix::{ Config as SignatureConfig, }; -/// A Repo and Client type backed by awc +/// A Repo and Deliver type backed by awc /// /// This client is generic over it's Cryptography. It signs it's requests with HTTP Signatures, and /// computes digests of it's request bodies. It also propagates the OpenTelemetry Trace ID if that diff --git a/apub-background-jobs/src/lib.rs b/apub-background-jobs/src/lib.rs index 7a3ab74..93dcb53 100644 --- a/apub-background-jobs/src/lib.rs +++ b/apub-background-jobs/src/lib.rs @@ -1,7 +1,7 @@ //! An implementation of Client based on background_jobs //! ```rust //! use apub_core::session::SessionFactory; -//! use apub_background_jobs::{client, ClientFactory, DeliverJob}; +//! use apub_background_jobs::{JobClient, ClientFactory, DeliverJob}; //! use apub_openssl::OpenSsl; //! use apub_reqwest::{ReqwestClient, SignatureConfig}; //! use background_jobs::{memory_storage::Storage, WorkerConfig}; @@ -49,7 +49,7 @@ //! //! let inbox: Url = "https://masto.asonix.dog/inbox".parse()?; //! // let activity = /* ... */; -//! // client::(crypto, queue_handle.clone()).enqueue(inbox, &activity)?; +//! // JobClient::::new(crypto, queue_handle.clone()).enqueue(inbox, &activity)?; //! //! drop(manager); //! @@ -93,7 +93,7 @@ pub struct DeliverJob { _state: PhantomData, } -/// The "Client" implementation, generic over State and Crypto +/// A Deliver implementation backed by Background Jobs pub struct JobClient { handle: QueueHandle, crypto: State::Crypto, @@ -104,27 +104,6 @@ pub struct JobClient { #[derive(Debug)] pub struct EnqueueError(pub anyhow::Error); -/// produce a Client given Cryptography and a QueueHandle -/// -/// This client should be used only to deliver on behalf of the actor associated with the provided -/// crypto. In most cases, this means the client is 1-time-use -pub fn client(crypto: State::Crypto, handle: QueueHandle) -> JobClient -where - State: ClientFactory + SessionFactory + Clone + 'static, - State::Crypto: for<'de> serde::de::Deserialize<'de> - + serde::ser::Serialize - + DigestFactory - + PrivateKey - + Clone - + 'static, -{ - JobClient { - handle, - crypto, - _state: PhantomData, - } -} - impl JobClient where State: ClientFactory + SessionFactory + Clone + 'static, @@ -136,6 +115,18 @@ where + std::panic::UnwindSafe + 'static, { + /// produce a Client given Cryptography and a QueueHandle + /// + /// This client should be used only to deliver on behalf of the actor associated with the provided + /// crypto. In most cases, this means the client is 1-time-use + pub fn new(crypto: State::Crypto, handle: QueueHandle) -> Self { + JobClient { + handle, + crypto, + _state: PhantomData, + } + } + /// Enqueue the activity to be delivered, consuming the client pub async fn enqueue(self, inbox: Url, activity: &T) -> Result<(), EnqueueError> where diff --git a/apub-core/src/session.rs b/apub-core/src/session.rs index 9350219..8891836 100644 --- a/apub-core/src/session.rs +++ b/apub-core/src/session.rs @@ -11,10 +11,6 @@ use url::Url; /// An included [`RequestCountSession`] type is included, which simply counts how many requests the /// session has observed and indicates future requests shouldn't be executed after it's limit is /// hit. -/// -/// An additional [`BreakerSession`] type is provied by the apub-breaker-session library to keep -/// track of how many consecutive failures to a given domain have occurred, and prevents future -/// requests to that domain until a timeout has expired. pub trait Session { /// Returns false if a request to the given URL should not procede fn should_procede(&mut self, url: &Url) -> bool; diff --git a/apub-reqwest/src/lib.rs b/apub-reqwest/src/lib.rs index 7084ad2..3f1d336 100644 --- a/apub-reqwest/src/lib.rs +++ b/apub-reqwest/src/lib.rs @@ -21,7 +21,7 @@ use url::Url; pub use http_signature_normalization_reqwest::Config as SignatureConfig; -/// A Repo and Client type backed by reqwest +/// A Repo and Deliver type backed by reqwest /// /// This client is generic over it's Cryptography. It signs it's requests with HTTP Signatures, and /// computes digests of it's request bodies. diff --git a/examples/actix-web-example/src/main.rs b/examples/actix-web-example/src/main.rs index 81caa48..7553788 100644 --- a/examples/actix-web-example/src/main.rs +++ b/examples/actix-web-example/src/main.rs @@ -1,21 +1,30 @@ use actix_web::{middleware::Logger, web, App, FromRequest, HttpServer, ResponseError}; use apub::{ - activitypub::SimplePublicKey, - actix_web::{ + activitypub::keys::{ + publickey::{PublicKeyError, PublicKeyRepoFactory}, + KeyId, PrivateKeyRepo, PrivateKeyRepoFactory, PublicKeyRepo, SimplePublicKey, + }, + clients::{ + awc::{AwcError, SignatureConfig as AwcSignatureConfig}, + AwcClient, + }, + cryptography::{ + rustcrypto::{RsaVerifier, RustcryptoError, Sha256Digest}, + DigestFactory, Rustcrypto, VerifyFactory, + }, + ingest::{ + validate_authority, validate_hosts, validate_inbox, + validators::{ + AuthorityError, HostError, InboxError, InboxType, ValidateAuthority, ValidateHosts, + ValidateInbox, + }, + Authority, + }, + servers::actix_web::{ inbox, serve_objects, Config, SignatureConfig as ActixWebSignatureConfig, VerifyError, }, - awc::{AwcClient, AwcError, SignatureConfig as AwcSignatureConfig}, - digest::{DigestFactory, Sha256Digest}, - ingest::{ - validate_authority, validate_hosts, validate_inbox, Authority, AuthorityError, FullRepo, - HostError, InboxError, InboxType, Ingest, ValidateAuthority, ValidateHosts, ValidateInbox, - }, - repo::{Dereference, Repo, RepoFactory}, - session::{BreakerSession, RequestCountSession, Session, SessionFactory}, - signature::{ - KeyId, PrivateKeyRepo, PrivateKeyRepoFactory, PublicKeyError, PublicKeyRepo, - PublicKeyRepoFactory, RsaVerifier, Rustcrypto, RustcryptoError, VerifyFactory, - }, + session::{BreakerSession, RequestCountSession, SessionFactory}, + Dereference, FullRepo, Ingest, Repo, RepoFactory, Session, }; use dashmap::DashMap; use example_types::{AcceptedActivity, ActivityType, ObjectId}; diff --git a/examples/awc-example/src/main.rs b/examples/awc-example/src/main.rs index 9a035a8..2c6fbba 100644 --- a/examples/awc-example/src/main.rs +++ b/examples/awc-example/src/main.rs @@ -1,8 +1,8 @@ use apub::{ - deliver::Deliverable, - awc::{AwcClient, SignatureConfig}, - signature::Rustcrypto, + clients::{awc::SignatureConfig, AwcClient}, + cryptography::Rustcrypto, session::{BreakerSession, RequestCountSession}, + Deliverable, }; use example_types::{object_id, NoteType, ObjectId}; use rsa::RsaPrivateKey; diff --git a/examples/background-jobs-example/src/main.rs b/examples/background-jobs-example/src/main.rs index 06c2e8c..2930500 100644 --- a/examples/background-jobs-example/src/main.rs +++ b/examples/background-jobs-example/src/main.rs @@ -1,9 +1,12 @@ use apub::{ - awc::{AwcClient, SignatureConfig}, - background_jobs::{client, ClientFactory, DeliverJob}, - deliver::Deliverable, + clients::{ + awc::SignatureConfig, + background_jobs::{ClientFactory, DeliverJob}, + AwcClient, JobClient, + }, + cryptography::Rustcrypto, session::{BreakerSession, RequestCountSession, SessionFactory}, - signature::Rustcrypto, + Deliverable, }; use background_jobs::{memory_storage::Storage, WorkerConfig}; use example_types::{object_id, Note, NoteType}; @@ -84,7 +87,7 @@ async fn main() -> Result<(), Box> { }; note.deliver( &inbox, - &client::(crypto, manager.queue_handle().clone()), + &JobClient::::new(crypto, manager.queue_handle().clone()), (), ) .await?; diff --git a/examples/example-types/src/lib.rs b/examples/example-types/src/lib.rs index aeb3a0c..e14fccf 100644 --- a/examples/example-types/src/lib.rs +++ b/examples/example-types/src/lib.rs @@ -1,8 +1,6 @@ use apub::{ activitypub::{Activity, DeliverableObject, Object}, - deliver::Deliverable, - repo::{Dereference, Repo}, - session::Session, + Deliverable, Dereference, Repo, Session, }; use std::{ fmt::Display, @@ -85,13 +83,13 @@ impl Dereference for ObjectId { #[derive(Clone, Debug, serde::Deserialize, serde::Serialize)] #[serde(transparent)] -pub struct ObjectId(apub::object_id::ObjectId<'static, Kind>); +pub struct ObjectId(apub::ObjectId<'static, Kind>); pub fn object_id(id: Url) -> ObjectId where ObjectId: Dereference, { - ObjectId(apub::object_id::ObjectId::new_owned(id)) + ObjectId(apub::ObjectId::new_owned(id)) } #[derive(Clone, Debug, serde::Deserialize, serde::Serialize)] diff --git a/examples/reqwest-example/src/main.rs b/examples/reqwest-example/src/main.rs index 41fc9a8..3133057 100644 --- a/examples/reqwest-example/src/main.rs +++ b/examples/reqwest-example/src/main.rs @@ -1,8 +1,8 @@ use apub::{ - deliver::Deliverable, - reqwest::{ReqwestClient, SignatureConfig}, - signature::OpenSsl, + clients::{reqwest::SignatureConfig, ReqwestClient}, + cryptography::OpenSsl, session::{BreakerSession, RequestCountSession}, + Deliverable, }; use example_types::{object_id, NoteType, ObjectId}; use openssl::{pkey::PKey, rsa::Rsa}; diff --git a/src/lib.rs b/src/lib.rs index 6034280..fc6c3a9 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -1,89 +1,251 @@ -pub mod repo { - pub use apub_core::repo::{Dereference, Repo, RepoFactory}; -} +//! # Apub: utilities for building activitypub servers +//! +//! ## Delivery +//! +//! The [`Deliver`] trait defines how to deliver objects to remote servers. There are three +//! implementations of `Deliver` provided by this crate: one backed by Reqwest, one backed by Awc, +//! and one backed by Background Jobs, with the HTTP portion backed by another Deliver +//! implementation. +//! +//! For more information, see the [`clients`] module +//! +//! ## Fetching +//! +//! The [`Repo`] trait defines how to fetch an Object from somewhere. This is generic enough to be +//! used for fetching from a Database as well as fetching from a remote server. There are no +//! database implementations provided by default, implementing `Repo` is simple enough with the help +//! of [`async_trait`](https://docs.rs/async-trait/0.1.51/async_trait/). There are two HTTP +//! implementations of `Repo` provided by apub, one backed by Reqwest and one backed by Apub. +//! +//! For more information, see the [`clients`] module +//! +//! ## Accepting +//! +//! The [`Ingest`] trait is the main point for accepting activities into your system. It is designed +//! to be used from the context of the [`FullRepo`] trait, which combines a local repository, an +//! HTTP repository, and your custom [`Ingest`] implementation. Using a `FullRepo` provides an +//! `Ingest` with all the peices needed to fully ingest an activitypub activity. Since Activities +//! often reference each other, being able to pause ingesting one activity while you ingest one of +//! it's dependencies is super important. that's why `FullRepo` provides an `ingest_activity` +//! method, which can be called at any point within an Ingest implementation to recursively ingest a +//! new object. +//! +//! `Ingest` is generic over the type it ingests. This allows for a single type to accept multiple +//! kinds of activities with different implementations. It may be worthwile to implement +//! `Ingest` differently from `Ingest`. Further, implementations can +//! implement `Ingest where A: SomeTrait`. Creating generic `Ingest` implementations can enable +//! better code re-use between kinds of activities. +//! +//! See the [`ingest`] module for more types and traits to help with accepting activities +//! +//! ## Request Utilities +//! +//! When you're building an application that frequently makes HTTP Requests, you may want to +//! preemptively stop a request from continuing. For this behavior, apub provides the [`Session`] +//! trait. When a request is made via Awc or Reqwest's Repo or Deliver implementations, a check to +//! the current `Session` is made to see if the given request should procede, and when the request +//! finishes, the current session is notified of whether the request completed succesfully or +//! failed. Two Session types are provided by default: [`BreakerSession`] and +//! [`RequestCountSession`]. `BreakerSession` is designed to be shared between all requests the +//! application makes, and will stop requests to domains with too many consecutive failures for a +//! configured duration. `RequestCountSession` will keep track of how many requests a client makes +//! in total, and prevents future requests if a configured limit is exceeded. A new +//! `RequestCountSession` should be instantiated for each `Ingest` +//! +//! +//! ## Request Validation +//! +//! Much like transportation, apub provides two implementations for cryptography, one backed by +//! OpenSSL and one backed by the Rustcrypto libraries. When using the provided HTTP Repo +//! implementations, HTTP SIgnatures and HTTP Digests will automatically be applied to all requests. +//! +//! For dealing with Public and Private keys, two additional traits are provided: [`PublicKeyRepo`] +//! and [`PrivateKeyRepo`]. These traits define an API for storing and retrieving keys that server +//! ingegrations can rely on for signing and validating requests. +//! +//! For more information, see the [`cryptography`] and [`activitypub::keys`] modules. +//! +//! ## ActivityPub Impelementation +//! +//! Apub provides basic traits for dealing with a few kinds of activitypub Objects. These traits are +//! far from a perfect representation of the activitypub spec, and are instead meant to ease dealing +//! with common types. +//! +//! In addition, apub provides simple concrete implementations for an Object, and Actor, an +//! Activity, and a Public Key. These implementations may be too basic to be of much help, but are +//! included to aide in prototyping. The `SimplePublicKey` type is used in the [`PublicKeyRepo`] +//! api. +//! +//! For more information, see the [`activitypub`] module. +//! +//! ## Feature Flags +//! +//! | Feature | Description | default | +//! | -------------------- | ---------------------------------------------------- | ------- | +//! | full | Enable every feature | false | +//! | with-actix-web | Enable apub's actix-web integration | false | +//! | with-awc | Enable apub's awc Repo and Deliver | false | +//! | with-background-jobs | Enable apub's background_jobs delivery integration | false | +//! | with-openssl | Enable HTTP Signatures with OpenSSL | false | +//! | with-reqwest | Enable apub's reqwest Repo and Deliver | false | +//! | with-rustcrypto | Enable HTTP Signatures with rustcrypto | false | +//! | utils | Enable helper types and traits not strictly required | true | +//! +//! ## Examples +//! See the [examples directory](https://git.asonix.dog/asonix/apub/src/branch/main/examples) for +//! concrete implementations. +//! +//! [`BreakerSession`]: session::BreakerSession +//! [`RequestCountSession`]: session::RequestCountSession +//! [`PublicKeyRepo`]: activitypub::keys::PublicKeyRepo +//! [`PrivateKeyRepo`]: activitypub::keys::PrivateKeyRepo +pub use apub_core::{ + deliver::{Deliver, Deliverable}, + ingest::{FullRepo, Ingest}, + object_id::ObjectId, + repo::{Dereference, Repo, RepoFactory}, + session::Session, +}; -pub mod deliver { - pub use apub_core::deliver::{Deliver, Deliverable}; -} +pub mod clients { + //! Ready-made Implementations of Repo and Deliver -pub mod object_id { - pub use apub_core::object_id::ObjectId; -} + #[cfg(feature = "apub-awc")] + pub use apub_awc::AwcClient; -#[cfg(feature = "apub-awc")] -pub mod awc { - pub use apub_awc::{ - AwcClient, AwcError, InvalidHeaderValue, PrepareSignError, SignatureConfig, SignatureError, - }; -} + #[cfg(feature = "apub-reqwest")] + pub use apub_reqwest::ReqwestClient; -#[cfg(feature = "apub-reqwest")] -pub mod reqwest { - pub use apub_reqwest::{ReqwestClient, ReqwestError, SignatureConfig, SignatureError}; + #[cfg(feature = "apub-background-jobs")] + pub use apub_background_jobs::JobClient; + + #[cfg(feature = "apub-awc")] + pub mod awc { + pub use apub_awc::{ + AwcError, InvalidHeaderValue, PrepareSignError, SignatureConfig, SignatureError, + }; + } + + #[cfg(feature = "apub-reqwest")] + pub mod reqwest { + pub use apub_reqwest::{ReqwestError, SignatureConfig, SignatureError}; + } + + #[cfg(feature = "apub-background-jobs")] + pub mod background_jobs { + pub use apub_background_jobs::{ClientFactory, DeliverJob, EnqueueError}; + } } pub mod ingest { - pub use apub_core::ingest::{Authority, FullRepo, Ingest}; + //! Utilities for ingesting activities + + pub use apub_core::ingest::Authority; #[cfg(feature = "apub-ingest")] - pub use apub_ingest::{ - validate_authority, validate_hosts, validate_inbox, AuthorityError, HostError, InboxError, - InboxType, ValidateAuthority, ValidateHosts, ValidateInbox, - }; + pub use apub_ingest::{validate_authority, validate_hosts, validate_inbox}; + + #[cfg(feature = "apub-ingest")] + pub mod validators { + //! Pre-defined validators for Ingest implementations + + pub use apub_ingest::{ + AuthorityError, HostError, InboxError, InboxType, ValidateAuthority, ValidateHosts, + ValidateInbox, + }; + } } #[cfg(feature = "apub-actix-web")] -pub mod actix_web { - pub use apub_actix_web::{inbox, serve_objects, Config, SignatureConfig, VerifyError}; +pub mod servers { + //! apub integration with http servers + + pub mod actix_web { + //! actix-web integration + pub use apub_actix_web::{inbox, serve_objects, Config, SignatureConfig, VerifyError}; + } } pub mod activitypub { + //! Types and traits for building activitypub servers + pub use apub_core::activitypub::{Activity, Actor, DeliverableObject, Object, PublicKey}; - pub use apub_core::activitypub_ext::{dereference, ActivityExt, ActorExt, Out}; + pub mod extensions { + //! Extensions of the activitypub traits, with dereferencing via FullRepo - #[cfg(feature = "apub-publickey")] - pub use apub_publickey::SimplePublicKey; + pub use apub_core::activitypub_ext::{dereference, ActivityExt, ActorExt, Out}; + } - #[cfg(feature = "apub-simple-activitypub")] - pub use apub_simple_activitypub::{SimpleActivity, SimpleActor, SimpleObject}; -} + pub mod simple { + //! Basic concrete types implementing activitypub traits -pub mod background_jobs { - #[cfg(feature = "apub-background-jobs")] - pub use apub_background_jobs::{client, ClientFactory, DeliverJob, EnqueueError, JobClient}; + #[cfg(feature = "apub-simple-activitypub")] + pub use apub_simple_activitypub::{SimpleActivity, SimpleActor, SimpleObject}; + } + + pub mod keys { + //! Helpers for dealing with public and private keys + + pub use apub_privatekey::{KeyId, PrivateKeyRepo, PrivateKeyRepoFactory}; + + #[cfg(feature = "apub-publickey")] + pub use apub_publickey::{PublicKeyRepo, SimplePublicKey}; + + pub mod publickey { + //! More types and traits for dealing with public keys + + #[cfg(feature = "apub-publickey")] + pub use apub_publickey::{PublicKeyClient, PublicKeyError, PublicKeyRepoFactory}; + } + } } pub mod session { - pub use apub_core::session::{RequestCountSession, Session, SessionError, SessionFactory}; + //! Implementations and extra traits for Sessions + + pub use apub_core::session::{RequestCountSession, SessionError, SessionFactory}; #[cfg(feature = "apub-breaker-session")] pub use apub_breaker_session::BreakerSession; } -pub mod digest { - pub use apub_core::digest::{Digest, DigestBuilder, DigestFactory}; +pub mod cryptography { + //! Cryptography implementations for HTTP Signatures - #[cfg(feature = "apub-openssl")] - pub use apub_openssl::OpenSslDigest; - - #[cfg(feature = "apub-rustcrypto")] - pub use apub_rustcrypto::Sha256Digest; -} - -pub mod signature { - pub use apub_core::signature::{PrivateKey, Sign, Verify, VerifyBuilder, VerifyFactory}; - - #[cfg(feature = "apub-openssl")] - pub use apub_openssl::{OpenSsl, OpenSslSigner, OpenSslVerifier}; - - #[cfg(feature = "apub-rustcrypto")] - pub use apub_rustcrypto::{RsaSigner, RsaVerifier, Rustcrypto, RustcryptoError}; - - #[cfg(feature = "apub-publickey")] - pub use apub_publickey::{ - PublicKeyClient, PublicKeyError, PublicKeyRepo, PublicKeyRepoFactory, + pub use apub_core::{ + digest::DigestFactory, + signature::{PrivateKey, VerifyFactory}, }; - pub use apub_privatekey::{KeyId, PrivateKeyRepo, PrivateKeyRepoFactory}; + #[cfg(feature = "apub-openssl")] + pub use apub_openssl::OpenSsl; + + #[cfg(feature = "apub-rustcrypto")] + pub use apub_rustcrypto::Rustcrypto; + + pub mod digest { + //! More traits for dealing with digests + + pub use apub_core::digest::{Digest, DigestBuilder}; + } + + #[cfg(feature = "apub-openssl")] + pub mod openssl { + //! More openssl types for signing and verification + + pub use apub_openssl::{OpenSslDigest, OpenSslSigner, OpenSslVerifier}; + } + + #[cfg(feature = "apub-rustcrypto")] + pub mod rustcrypto { + //! More rustcrypto types for signing and verification + + pub use apub_rustcrypto::{RsaSigner, RsaVerifier, RustcryptoError, Sha256Digest}; + } + + pub mod signature { + //! More traits for signing and verification + pub use apub_core::signature::{PrivateKeyBuilder, Sign, Verify, VerifyBuilder}; + } }