From: W. Trevor King Date: Wed, 21 Mar 2012 15:15:24 +0000 (-0400) Subject: Restructure and cleanup pgp-mime now that it's a stand alone package. X-Git-Tag: v0.2 X-Git-Url: http://git.tremily.us/?a=commitdiff_plain;h=213a9ee82b8c8039ef93bfb6ed88f2201e48ea41;p=pgp-mime.git Restructure and cleanup pgp-mime now that it's a stand alone package. --- diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..142c6c7 --- /dev/null +++ b/.gitignore @@ -0,0 +1,3 @@ +*.pyc +AUTHORS +build diff --git a/.update-copyright.conf b/.update-copyright.conf new file mode 100644 index 0000000..1d020a6 --- /dev/null +++ b/.update-copyright.conf @@ -0,0 +1,18 @@ +[project] +name: pgp-mime +vcs: Git + +[files] +authors: yes +files: yes +ignored: COPYING, README, .update-copyright.conf, .git* + +[copyright] +short: %(project)s comes with ABSOLUTELY NO WARRANTY and is licensed under the GNU General Public License. +long: This file is part of %(project)s. + + %(project)s 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. + + %(project)s 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 %(project)s. If not, see . diff --git a/COPYING b/COPYING new file mode 100644 index 0000000..94a9ed0 --- /dev/null +++ b/COPYING @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 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 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. + + + Copyright (C) + + 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 . + +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: + + Copyright (C) + 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 +. + + 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 +. diff --git a/README b/README new file mode 100644 index 0000000..d30e23b --- /dev/null +++ b/README @@ -0,0 +1,138 @@ +Python module and for constructing and sending PGP/MIME email. + +The ``pgp_mime`` module makes it easy to construct and dispatch signed +and/or encrypted email using PGP_ and :RFC:`3156`. It uses GnuPG_ to +perform the cryptography. + +Installation +============ + +Packages +-------- + +Gentoo +~~~~~~ + +I've packaged ``pgp-mime`` for Gentoo_. You need layman_ and +my `wtk overlay`_. Install with:: + + # emerge -av app-portage/layman + # layman --add wtk + # emerge -av dev-python/pgp-mime + +Dependencies +------------ + +``pgp-mime`` is a simple package with no external dependencies outside +the Python 3 standard library. There are a number of GnuPG_ wrappers +for python `out there`__, but none of them seem mature/stable enough +to be worth installing. Instead, we use the ``subprocess`` module to +call ``gpg`` directly. If this isn't working for you, you need only +replace the ``*_bytes`` commands which handle the cryptography. + +__ wrappers_ + +Installing by hand +------------------ + +``pgp-mime`` is available as a Git_ repository:: + + $ git clone git://tremily.us/pgp-mime.git + +See the homepage_ for details. To install the checkout, run the +standard:: + + $ python setup.py install + +Usage +===== + +Pgp-mime has grown up as I've become more experienced with Python. +The current interface is much simpler, and there are lots of +docstrings showing you how to use each function. + +If you're looking for a higher level example, pgp-mime includes a +command line script ``send-pgp-mime.py`` that allows you to send +signed and/or encrypted email from the command line. I recommend you +use ``gpg2`` with my `wrappers and pinentry program`_ to allow easy +pinentry from the command line. Here's how you could mail signed +grades to your class:: + + $ FROM="From: Rincewind " + $ head -n2 grades + Twoflower |9 + Eric Thursley |10 + $ while read LINE; do + STUDENT=$(echo "$LINE" | cut -d '|' -f 1) + GRADE=$(echo "$LINE" | cut -d '|' -f 2) + HEAD=$(echo -e "$FROM\nTo: $STUDENT\nSubject: Grades") + BODY=$(echo -e "$STUDENT,\n\nYou got a $GRADE.\n\nGood job.") + send-pgp-mime.py -H <(echo "$HEAD") -B <(echo "$BODY") --mode sign + done < grades + +If you can convince your students to get PGP keys, you could also +encrypt their grades by changing ``--mode sign`` to ``--mode +sign-encrypt``. + +Configuring the SMTP connection +------------------------------- + +Pgp-mime supports two methods for sending messages (via +``pgp_mime.mail``). It can either call your system's ``sendmail`` +equivalent, or connect directly to an SMTP_ server using ``smtplib``. +Since I imagine SMTP will be more common, you can easily configure +your SMTP connection via ``~/.config/pgp-mime.conf``:: + + [smtp] + host: smtp.mail.uu.edu + port: 587 + starttls: yes + username: rincewind + password: 7ugg@g3 + +All of these fields are optional. ``host`` defaults to ``localhost`` +and ``port`` defaults to 25. If ``username`` is not given, we do not +attempt to login to the SMTP server after connecting. + +If ``starttls`` is ``no`` or not given, the SMTP transaction occurs in +plain text (although the underlying emails will still be encrypted). +However, if you set a ``username`` (to login), pgp-mime will require a +STARTTLS_ to protect your password from sniffing. + +Testing +======= + +Run the internal unit tests using nose_:: + + $ nosetests --with-doctest --doctest-tests pgp-mime + +If a Python-3-version of ``nosetests`` is not the default on your +system, you may need to try something like:: + + $ nosetests-3.2 --with-doctest --doctest-tests pgp-mime + +Licence +======= + +This project is distributed under the `GNU General Public License +Version 3`_ or greater. + +Author +====== + +W. Trevor King +wking@drexel.edu + +.. _PGP: http://en.wikipedia.org/wiki/Pretty_Good_Privacy +.. _Gentoo: http://www.gentoo.org/ +.. _layman: http://layman.sourceforge.net/ +.. _wtk overlay: http://blog.tremily.us/posts/Gentoo_overlay +.. _wrappers: http://wiki.python.org/moin/GnuPrivacyGuard +.. _Git: http://git-scm.com/ +.. _homepage: http://blog.tremily.us/posts/pgp-mime/ +.. _wrappers and pinentry program: http://blog.tremily.us/posts/gpg-agent/ +.. _SMTP: http://en.wikipedia.org/wiki/Simple_Mail_Transfer_Protocol +.. _STARTTLS: http://en.wikipedia.org/wiki/STARTTLS +.. _GnuPG: http://www.gnupg.org/ +.. _nose: http://readthedocs.org/docs/nose/en/latest/ +.. _GNU General Public License Version 3: http://www.gnu.org/licenses/gpl.html diff --git a/bin/send-pgp-mime.py b/bin/send-pgp-mime.py new file mode 100755 index 0000000..a499754 --- /dev/null +++ b/bin/send-pgp-mime.py @@ -0,0 +1,158 @@ +#!/usr/bin/env python3 +# Copyright + +"""Scriptable PGP MIME email using ``gpg``. + +You can use ``gpg-agent`` for passphrase caching if your key requires +a passphrase (it better!). Example usage would be to install +``gpg-agent``, and then run:: + + $ export GPG_TTY=`tty` + $ eval $(gpg-agent --daemon) + +in your shell before invoking this script. See ``gpg-agent(1)`` for +more details. +""" + +import codecs as _codecs +import configparser as _configparser +import logging as _logging +import mimetypes as _mimetypes +import os.path as _os_path +import sys as _sys + +from email.encoders import encode_base64 as _encode_base64 +from email.mime.application import MIMEApplication as _MIMEApplication +from email.mime.audio import MIMEAudio as _MIMEAudio +from email.mime.image import MIMEImage as _MIMEImage +from email.mime.multipart import MIMEMultipart as _MIMEMultipart +from email.mime.nonmultipart import MIMENonMultipart as _MIMENonMultipart + +import pgp_mime as _pgp_mime + + +STDIN_USED = False + + +def read_file(filename=None, encoding='us-ascii'): + global STDIN_USED + if filename == '-': + assert STDIN_USED == False, STDIN_USED + STDIN_USED = True + return _sys.stdin.read() + if filename: + return _codecs.open(filename, 'r', encoding).read() + raise ValueError('neither filename nor descriptor given for reading') + +def load_attachment(filename, encoding='us-ascii'): + mimetype,content_encoding = _mimetypes.guess_type(filename) + if mimetype is None or content_encoding is not None: + mimetype = 'application/octet-stream' + maintype,subtype = mimetype.split('/', 1) + _pgp_mime.LOG.info('loading attachment {} as {} ({})'.format( + filename, mimetype, content_encoding)) + if maintype == 'text': + text = read_file(filename=filename, encoding=encoding) + attachment = _pgp_mime.encodedMIMEText(text) + del attachment['content-disposition'] + else: + data = open(filename, 'rb').read() + if maintype == 'application': + attachment = _MIMEApplication(data, subtype) + elif maintype == 'audio': + attachment = _MIMEAudio(data) + elif maintype == 'image': + attachment = _MIMEImage(data) + else: + attachment = _MIMENonMultipary(maintype, subtype) + attachment.set_payload(data, _encode_base64) + attachment.add_header( + 'Content-Disposition', 'attachment', filename=filename) + return attachment + + +if __name__ == '__main__': + import argparse + + doc_lines = __doc__.splitlines() + parser = argparse.ArgumentParser( + description = doc_lines[0], + epilog = '\n'.join(doc_lines[1:]).strip(), + version=_pgp_mime.__version__, + formatter_class=argparse.RawDescriptionHelpFormatter) + parser.add_argument( + '-e', '--encoding', metavar='ENCODING', default='utf-8', + help='encoding for input files') + parser.add_argument( + '-H', '--header-file', metavar='FILE', + help='file containing email header') + parser.add_argument( + '-B', '--body-file', metavar='FILE', + help='file containing email body') + parser.add_argument( + '-a', '--attachment', metavar='FILE', action='append', + help='add an attachment to your message') + parser.add_argument( + '-m', '--mode', default='sign', metavar='MODE', + choices=['sign', 'encrypt', 'sign-encrypt', 'plain'], + help='encryption mode') + parser.add_argument( + '-s', '--sign-as', metavar='KEY', + help="gpg key to sign with (gpg's -u/--local-user)") + parser.add_argument( + '-c', '--config', metavar='FILE', + default=_os_path.expanduser(_os_path.join( + '~', '.config', 'smtplib.conf')), + help='SMTP config file for sending mail'), + parser.add_argument( + '--output', action='store_const', const=True, + help="don't mail the generated message, print it to stdout instead") + parser.add_argument( + '-V', '--verbose', default=0, action='count', + help='increment verbosity') + + args = parser.parse_args() + + if args.verbose: + _pgp_mime.LOG.setLevel(max( + _logging.DEBUG, _pgp_mime.LOG.level - 10*args.verbose)) + + header_text = read_file(filename=args.header_file, encoding=args.encoding) + header = _pgp_mime.header_from_text(header_text) + body_text = read_file(filename=args.body_file, encoding=args.encoding) + body = _pgp_mime.encodedMIMEText(body_text) + if args.attachment: + b = _MIMEMultipart() + b.attach(body) + body = b + _mimetypes.init() + for attachment in args.attachment: + body.attach(load_attachment( + filename=attachment, encoding=args.encoding)) + if 'encrypt' in args.mode: + recipients = [email for name,email in _pgp_mime.email_targets(header)] + if args.mode == 'sign': + body = _pgp_mime.sign(body, sign_as=args.sign_as) + elif args.mode == 'encrypt': + body = _pgp_mime.encrypt(body, recipients=recipients) + elif args.mode == 'sign-encrypt': + body = _pgp_mime.sign_and_encrypt( + body, sign_as=args.sign_as, recipients=recipients) + elif args.mode == 'plain': + pass + else: + raise Exception('unrecognized mode {}'.format(args.mode)) + message = _pgp_mime.attach_root(header, body) + + if args.output: + print(message.as_string()) + else: + config = _configparser.ConfigParser() + config.read(args.config) + params = _pgp_mime.get_smtp_params(config) + smtp = _pgp_mime.get_smtp(*params) + try: + _pgp_mime.mail(message, smtp) + finally: + _pgp_mime.LOG.info('disconnect from SMTP server') + smtp.quit() diff --git a/interfaces/email/interactive/send_pgp_mime.py b/interfaces/email/interactive/send_pgp_mime.py deleted file mode 100644 index b46eeb4..0000000 --- a/interfaces/email/interactive/send_pgp_mime.py +++ /dev/null @@ -1,611 +0,0 @@ -#!/usr/bin/python -# -# Copyright (C) 2009 W. Trevor King -# -# 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 2 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, write to the Free Software Foundation, Inc., -# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. -""" -Python module and command line tool for sending pgp/mime email. - -Mostly uses subprocess to call gpg and a sendmail-compatible mailer. -If you lack gpg, either don't use the encryption functions or adjust -the pgp_* commands. You may need to adjust the sendmail command to -point to whichever sendmail-compatible mailer you have on your system. -""" - -from cStringIO import StringIO -import os -import re -#import GnuPGInterface # Maybe should use this instead of subprocess -import smtplib -import subprocess -import sys -import tempfile -import types - -try: - from email import Message - from email.mime.text import MIMEText - from email.mime.multipart import MIMEMultipart - from email.mime.application import MIMEApplication - from email.encoders import encode_7or8bit - from email.generator import Generator - from email.parser import Parser - from email.utils import getaddress -except ImportError: - # adjust to old python 2.4 - from email import Message - from email.MIMEText import MIMEText - from email.MIMEMultipart import MIMEMultipart - from email.MIMENonMultipart import MIMENonMultipart - from email.Encoders import encode_7or8bit - from email.Generator import Generator - from email.Parser import Parser - from email.Utils import getaddresses - - getaddress = getaddresses - class MIMEApplication (MIMENonMultipart): - def __init__(self, _data, _subtype, _encoder, **params): - MIMENonMultipart.__init__(self, 'application', _subtype, **params) - self.set_payload(_data) - _encoder(self) - -usage="""usage: %prog [options] - -Scriptable PGP MIME email using gpg. - -You can use gpg-agent for passphrase caching if your key requires a -passphrase (it better!). Example usage would be to install gpg-agent, -and then run - export GPG_TTY=`tty` - eval $(gpg-agent --daemon) -in your shell before invoking this script. See gpg-agent(1) for more -details. Alternatively, you can send your passphrase in on stdin - echo 'passphrase' | %prog [options] -or use the --passphrase-file option - %prog [options] --passphrase-file FILE [more options] -Both of these alternatives are much less secure than gpg-agent. You -have been warned. -""" - -verboseInvoke = False -PGP_SIGN_AS = None -PASSPHRASE = None - -# The following commands are adapted from my .mutt/pgp configuration -# -# Printf-like sequences: -# %a The value of PGP_SIGN_AS. -# %f Expands to the name of a file with text to be signed/encrypted. -# %p Expands to the passphrase argument. -# %R A string with some number (0 on up) of pgp_reciepient_arg -# strings. -# %r One key ID (e.g. recipient email address) to build a -# pgp_reciepient_arg string. -# -# The above sequences can be used to optionally print a string if -# their length is nonzero. For example, you may only want to pass the -# -u/--local-user argument to gpg if PGP_SIGN_AS is defined. To -# optionally print a string based upon one of the above sequences, the -# following construct is used -# %??? -# where sequence_char is a character from the table above, and -# optional_string is the string you would like printed if status_char -# is nonzero. optional_string may contain other sequence as well as -# normal text, but it may not contain any question marks. -# -# see http://codesorcery.net/old/mutt/mutt-gnupg-howto -# http://www.mutt.org/doc/manual/manual-6.html#pgp_autosign -# http://tldp.org/HOWTO/Mutt-GnuPG-PGP-HOWTO-8.html -# for more details - -pgp_recipient_arg='-r "%r"' -pgp_stdin_passphrase_arg='--passphrase-fd 0' -pgp_sign_command='/usr/bin/gpg --no-verbose --quiet --batch %p --output - --detach-sign --armor --textmode %?a?-u "%a"? %f' -pgp_encrypt_only_command='/usr/bin/gpg --no-verbose --quiet --batch --output - --encrypt --armor --textmode --always-trust --encrypt-to "%a" %R -- %f' -pgp_encrypt_sign_command='/usr/bin/gpg --no-verbose --quiet --batch %p --output - --encrypt --sign %?a?-u "%a"? --armor --textmode --always-trust --encrypt-to "%a" %R -- %f' -sendmail='/usr/sbin/sendmail -t' - -def mail(msg, sendmail=None): - """ - Send an email Message instance on its merry way. - - We can shell out to the user specified sendmail in case - the local host doesn't have an SMTP server set up - for easy smtplib usage. - """ - if sendmail != None: - execute(sendmail, stdin=flatten(msg)) - return None - s = smtplib.SMTP() - s.connect() - s.sendmail(from_addr=source_email(msg), - to_addrs=target_emails(msg), - msg=flatten(msg)) - s.close() - -def header_from_text(text, encoding="us-ascii"): - """ - Simple wrapper for instantiating an email.Message from text. - >>> header = header_from_text('\\n'.join(['From: me@big.edu','To: you@big.edu','Subject: testing'])) - >>> print flatten(header) - From: me@big.edu - To: you@big.edu - Subject: testing - - - """ - text = text.strip() - if type(text) == types.UnicodeType: - text = text.encode(encoding) - # assume StringType arguments are already encoded - p = Parser() - return p.parsestr(text, headersonly=True) - -def guess_encoding(text): - if type(text) == types.StringType: - encoding = "us-ascii" - elif type(text) == types.UnicodeType: - for encoding in ["us-ascii", "iso-8859-1", "utf-8"]: - try: - text.encode(encoding) - except UnicodeError: - pass - else: - break - assert encoding != None - return encoding - -def encodedMIMEText(body, encoding=None): - if encoding == None: - encoding = guess_encoding(body) - if encoding == "us-ascii": - return MIMEText(body) - else: - # Create the message ('plain' stands for Content-Type: text/plain) - return MIMEText(body.encode(encoding), 'plain', encoding) - -def append_text(text_part, new_text): - original_payload = text_part.get_payload(decode=True) - new_payload = u"%s%s" % (original_payload, new_text) - new_encoding = guess_encoding(new_payload) - text_part.set_payload(new_payload.encode(new_encoding), new_encoding) - -def attach_root(header, root_part): - """ - Attach the email.Message root_part to the email.Message header - without generating a multi-part message. - """ - for k,v in header.items(): - root_part[k] = v - return root_part - -def execute(args, stdin=None, expect=(0,)): - """ - Execute a command (allows us to drive gpg). - """ - if verboseInvoke == True: - print >> sys.stderr, '$ '+args - try: - p = subprocess.Popen(args, stdin=subprocess.PIPE, stdout=subprocess.PIPE, stderr=subprocess.PIPE, shell=True, close_fds=True) - except OSError, e: - strerror = '%s\nwhile executing %s' % (e.args[1], args) - raise Exception, strerror - output, error = p.communicate(input=stdin) - status = p.wait() - if verboseInvoke == True: - print >> sys.stderr, '(status: %d)\n%s%s' % (status, output, error) - if status not in expect: - strerror = '%s\nwhile executing %s\n%s\n%d' % (args[1], args, error, status) - raise Exception, strerror - return status, output, error - -def replace(template, format_char, replacement_text): - """ - >>> replace('--textmode %?a?-u %a? %f', 'f', 'file.in') - '--textmode %?a?-u %a? file.in' - >>> replace('--textmode %?a?-u %a? %f', 'a', '0xHEXKEY') - '--textmode -u 0xHEXKEY %f' - >>> replace('--textmode %?a?-u %a? %f', 'a', '') - '--textmode %f' - """ - if replacement_text == None: - replacement_text = "" - regexp = re.compile('%[?]'+format_char+'[?]([^?]*)[?]') - if len(replacement_text) > 0: - str = regexp.sub('\g<1>', template) - else: - str = regexp.sub('', template) - regexp = re.compile('%'+format_char) - str = regexp.sub(replacement_text, str) - return str - -def flatten(msg, to_unicode=False): - """ - Produce flat text output from an email Message instance. - """ - assert msg != None - fp = StringIO() - g = Generator(fp, mangle_from_=False) - g.flatten(msg) - text = fp.getvalue() - if to_unicode == True: - encoding = msg.get_content_charset() or "utf-8" - text = unicode(text, encoding=encoding) - return text - -def source_email(msg, return_realname=False): - """ - Search the header of an email Message instance to find the - sender's email address. - """ - froms = msg.get_all('from', []) - from_tuples = getaddresses(froms) # [(realname, email_address), ...] - assert len(from_tuples) == 1 - if return_realname == True: - return from_tuples[0] # (realname, email_address) - return from_tuples[0][1] # email_address - -def target_emails(msg): - """ - Search the header of an email Message instance to find a - list of recipient's email addresses. - """ - tos = msg.get_all('to', []) - ccs = msg.get_all('cc', []) - bccs = msg.get_all('bcc', []) - resent_tos = msg.get_all('resent-to', []) - resent_ccs = msg.get_all('resent-cc', []) - resent_bccs = msg.get_all('resent-bcc', []) - all_recipients = getaddresses(tos + ccs + bccs + resent_tos - + resent_ccs + resent_bccs) - return [addr[1] for addr in all_recipients] - -class PGPMimeMessageFactory (object): - """ - See http://www.ietf.org/rfc/rfc3156.txt for specification details. - >>> from_addr = "me@big.edu" - >>> to_addr = "you@you.edu" - >>> header = header_from_text('\\n'.join(['From: %s'%from_addr,'To: %s'%to_addr,'Subject: testing'])) - >>> source_email(header) == from_addr - True - >>> target_emails(header) == [to_addr] - True - >>> m = PGPMimeMessageFactory('check 1 2\\ncheck 1 2\\n') - >>> print flatten(m.clearBodyPart()) - Content-Type: text/plain; charset="us-ascii" - MIME-Version: 1.0 - Content-Transfer-Encoding: 7bit - Content-Disposition: inline - - check 1 2 - check 1 2 - - >>> print flatten(m.plain()) - Content-Type: text/plain; charset="us-ascii" - MIME-Version: 1.0 - Content-Transfer-Encoding: 7bit - - check 1 2 - check 1 2 - - >>> signed = m.sign(header) - >>> signed.set_boundary('boundsep') - >>> print flatten(signed).replace('\\t', ' '*4) # doctest: +ELLIPSIS, +NORMALIZE_WHITESPACE - Content-Type: multipart/signed; protocol="application/pgp-signature"; - micalg="pgp-sha1"; boundary="boundsep" - MIME-Version: 1.0 - Content-Disposition: inline - - --boundsep - Content-Type: text/plain; charset="us-ascii" - MIME-Version: 1.0 - Content-Transfer-Encoding: 7bit - Content-Disposition: inline - - check 1 2 - check 1 2 - - --boundsep - MIME-Version: 1.0 - Content-Transfer-Encoding: 7bit - Content-Description: signature - Content-Type: application/pgp-signature; name="signature.asc"; - charset="us-ascii" - - -----BEGIN PGP SIGNATURE----- - ... - -----END PGP SIGNATURE----- - - --boundsep-- - >>> encrypted = m.encrypt(header) - >>> encrypted.set_boundary('boundsep') - >>> print flatten(encrypted).replace('\\t', ' '*4) # doctest: +ELLIPSIS, +NORMALIZE_WHITESPACE - Content-Type: multipart/encrypted; - protocol="application/pgp-encrypted"; - micalg="pgp-sha1"; boundary="boundsep" - MIME-Version: 1.0 - Content-Disposition: inline - - --boundsep - Content-Type: application/pgp-encrypted - MIME-Version: 1.0 - Content-Transfer-Encoding: 7bit - - Version: 1 - - --boundsep - MIME-Version: 1.0 - Content-Transfer-Encoding: 7bit - Content-Type: application/octet-stream; charset="us-ascii" - - -----BEGIN PGP MESSAGE----- - ... - -----END PGP MESSAGE----- - - --boundsep-- - >>> signedAndEncrypted = m.signAndEncrypt(header) - >>> signedAndEncrypted.set_boundary('boundsep') - >>> print flatten(signedAndEncrypted).replace('\\t', ' '*4) # doctest: +ELLIPSIS, +NORMALIZE_WHITESPACE - Content-Type: multipart/encrypted; - protocol="application/pgp-encrypted"; - micalg="pgp-sha1"; boundary="boundsep" - MIME-Version: 1.0 - Content-Disposition: inline - - --boundsep - Content-Type: application/pgp-encrypted - MIME-Version: 1.0 - Content-Transfer-Encoding: 7bit - - Version: 1 - - --boundsep - MIME-Version: 1.0 - Content-Transfer-Encoding: 7bit - Content-Type: application/octet-stream; charset="us-ascii" - - -----BEGIN PGP MESSAGE----- - ... - -----END PGP MESSAGE----- - - --boundsep-- - """ - def __init__(self, body): - self.body = body - def clearBodyPart(self): - body = encodedMIMEText(self.body) - body.add_header('Content-Disposition', 'inline') - return body - def passphrase_arg(self, passphrase=None): - if passphrase == None and PASSPHRASE != None: - passphrase = PASSPHRASE - if passphrase == None: - return (None,'') - return (passphrase, pgp_stdin_passphrase_arg) - def plain(self): - """ - text/plain - """ - return encodedMIMEText(self.body) - def sign(self, header, passphrase=None): - """ - multipart/signed - +-> text/plain (body) - +-> application/pgp-signature (signature) - """ - passphrase,pass_arg = self.passphrase_arg(passphrase) - body = self.clearBodyPart() - bfile = tempfile.NamedTemporaryFile() - bfile.write(flatten(body)) - bfile.flush() - - args = replace(pgp_sign_command, 'f', bfile.name) - if PGP_SIGN_AS == None: - pgp_sign_as = '<%s>' % source_email(header) - else: - pgp_sign_as = PGP_SIGN_AS - args = replace(args, 'a', pgp_sign_as) - args = replace(args, 'p', pass_arg) - status,output,error = execute(args, stdin=passphrase) - signature = output - - sig = MIMEApplication(_data=signature, - _subtype='pgp-signature; name="signature.asc"', - _encoder=encode_7or8bit) - sig['Content-Description'] = 'signature' - sig.set_charset('us-ascii') - - msg = MIMEMultipart('signed', micalg='pgp-sha1', - protocol='application/pgp-signature') - msg.attach(body) - msg.attach(sig) - - msg['Content-Disposition'] = 'inline' - return msg - def encrypt(self, header, passphrase=None): - """ - multipart/encrypted - +-> application/pgp-encrypted (control information) - +-> application/octet-stream (body) - """ - body = self.clearBodyPart() - bfile = tempfile.NamedTemporaryFile() - bfile.write(flatten(body)) - bfile.flush() - - recipients = [replace(pgp_recipient_arg, 'r', recipient) - for recipient in target_emails(header)] - recipient_string = ' '.join(recipients) - args = replace(pgp_encrypt_only_command, 'R', recipient_string) - args = replace(args, 'f', bfile.name) - if PGP_SIGN_AS == None: - pgp_sign_as = '<%s>' % source_email(header) - else: - pgp_sign_as = PGP_SIGN_AS - args = replace(args, 'a', pgp_sign_as) - status,output,error = execute(args) - encrypted = output - - enc = MIMEApplication(_data=encrypted, _subtype='octet-stream', - _encoder=encode_7or8bit) - enc.set_charset('us-ascii') - - control = MIMEApplication(_data='Version: 1\n', _subtype='pgp-encrypted', - _encoder=encode_7or8bit) - - msg = MIMEMultipart('encrypted', micalg='pgp-sha1', - protocol='application/pgp-encrypted') - msg.attach(control) - msg.attach(enc) - - msg['Content-Disposition'] = 'inline' - return msg - def signAndEncrypt(self, header, passphrase=None): - """ - multipart/encrypted - +-> application/pgp-encrypted (control information) - +-> application/octet-stream (body) - """ - passphrase,pass_arg = self.passphrase_arg(passphrase) - body = self.sign(header, passphrase) - body.__delitem__('Bcc') - bfile = tempfile.NamedTemporaryFile() - bfile.write(flatten(body)) - bfile.flush() - - recipients = [replace(pgp_recipient_arg, 'r', recipient) - for recipient in target_emails(header)] - recipient_string = ' '.join(recipients) - args = replace(pgp_encrypt_only_command, 'R', recipient_string) - args = replace(args, 'f', bfile.name) - if PGP_SIGN_AS == None: - pgp_sign_as = '<%s>' % source_email(header) - else: - pgp_sign_as = PGP_SIGN_AS - args = replace(args, 'a', pgp_sign_as) - args = replace(args, 'p', pass_arg) - status,output,error = execute(args, stdin=passphrase) - encrypted = output - - enc = MIMEApplication(_data=encrypted, _subtype='octet-stream', - _encoder=encode_7or8bit) - enc.set_charset('us-ascii') - - control = MIMEApplication(_data='Version: 1\n', - _subtype='pgp-encrypted', - _encoder=encode_7or8bit) - - msg = MIMEMultipart('encrypted', micalg='pgp-sha1', - protocol='application/pgp-encrypted') - msg.attach(control) - msg.attach(enc) - - msg['Content-Disposition'] = 'inline' - return msg - -def test(): - import doctest - doctest.testmod() - - -if __name__ == '__main__': - from optparse import OptionParser - - parser = OptionParser(usage=usage) - parser.add_option('-t', '--test', dest='test', action='store_true', - help='Run doctests and exit') - - parser.add_option('-H', '--header-file', dest='header_filename', - help='file containing email header', metavar='FILE') - parser.add_option('-B', '--body-file', dest='body_filename', - help='file containing email body', metavar='FILE') - - parser.add_option('-P', '--passphrase-file', dest='passphrase_file', - help='file containing gpg passphrase', metavar='FILE') - parser.add_option('-p', '--passphrase-fd', dest='passphrase_fd', - help='file descriptor from which to read gpg passphrase (0 for stdin)', - type="int", metavar='DESCRIPTOR') - - parser.add_option('--mode', dest='mode', default='sign', - help="One of 'sign', 'encrypt', 'sign-encrypt', or 'plain'. Defaults to %default.", - metavar='MODE') - - parser.add_option('-a', '--sign-as', dest='sign_as', - help="The gpg key to sign with (gpg's -u/--local-user)", - metavar='KEY') - - parser.add_option('--output', dest='output', action='store_true', - help="Don't mail the generated message, print it to stdout instead.") - - (options, args) = parser.parse_args() - - stdin_used = False - - if options.passphrase_file != None: - PASSPHRASE = file(options.passphrase_file, 'r').read() - elif options.passphrase_fd != None: - if options.passphrase_fd == 0: - stdin_used = True - PASSPHRASE = sys.stdin.read() - else: - PASSPHRASE = os.read(options.passphrase_fd) - - if options.sign_as: - PGP_SIGN_AS = options.sign_as - - if options.test == True: - test() - sys.exit(0) - - header = None - if options.header_filename != None: - if options.header_filename == '-': - assert stdin_used == False - stdin_used = True - header = sys.stdin.read() - else: - header = file(options.header_filename, 'r').read() - if header == None: - raise Exception, "missing header" - headermsg = header_from_text(header) - body = None - if options.body_filename != None: - if options.body_filename == '-': - assert stdin_used == False - stdin_used = True - body = sys.stdin.read() - else: - body = file(options.body_filename, 'r').read() - if body == None: - raise Exception, "missing body" - - m = PGPMimeMessageFactory(body) - if options.mode == "sign": - bodymsg = m.sign(header) - elif options.mode == "encrypt": - bodymsg = m.encrypt(header) - elif options.mode == "sign-encrypt": - bodymsg = m.signAndEncrypt(header) - elif options.mode == "plain": - bodymsg = m.plain() - else: - raise Exception("unrecognized mode '%s'" % options.mode) - - message = attach_root(headermsg, bodymsg) - if options.output == True: - message = flatten(message) - print message - else: - mail(message, sendmail) diff --git a/pgp_mime.py b/pgp_mime.py new file mode 100644 index 0000000..32ecf85 --- /dev/null +++ b/pgp_mime.py @@ -0,0 +1,699 @@ +# -*- coding: utf-8 -*- +# Copyright (C) 2009 W. Trevor King +# +# 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 2 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, write to the Free Software Foundation, Inc., +# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. +"""Python module and for constructing and sending pgp/mime email. + +Mostly uses subprocess to call ``gpg`` and sends mail using either +SMTP or a sendmail-compatible mailer. If you lack ``gpg``, either +don't use the encryption functions, adjust the ``GPG_*`` constants, or +adjust the ``*_bytes`` commands. +""" + +import configparser as _configparser +import io as _io +import logging as _logging +import os as _os +import re as _re +import smtplib as _smtplib +import smtplib as _smtplib +import subprocess as _subprocess + +from email.encoders import encode_7or8bit as _encode_7or8bit +from email.generator import Generator as _Generator +from email.header import decode_header as _decode_header +from email.message import Message as _Message +from email.mime.application import MIMEApplication as _MIMEApplication +from email.mime.multipart import MIMEMultipart as _MIMEMultipart +from email.mime.text import MIMEText as _MIMEText +from email.parser import Parser as _Parser +from email.utils import formataddr as _formataddr +from email.utils import getaddresses as _getaddresses + + +__version__ = '0.2' + + +LOG = _logging.getLogger('pgp-mime') +LOG.setLevel(_logging.ERROR) +LOG.addHandler(_logging.StreamHandler()) + +ENCODING = 'utf-8' +#ENCODING = 'iso-8859-1' + +GPG_ARGS = [ + '/usr/bin/gpg', '--no-verbose', '--quiet', '--batch', '--output', '-', + '--armor', '--textmode'] +GPG_SIGN_ARGS = ['--detach-sign'] +GPG_ENCRYPT_ARGS = ['--encrypt', '--always-trust'] +GPG_SIGN_AND_ENCRYPT_ARGS = ['--sign', '--encrypt', '--always-trust'] +SENDMAIL = ['/usr/sbin/sendmail', '-t'] + + +def get_smtp_params(config): + r"""Retrieve SMTP paramters from a config file. + + >>> from configparser import ConfigParser + >>> config = ConfigParser() + >>> config.read_string('\n'.join([ + ... '[smtp]', + ... 'host: smtp.mail.uu.edu', + ... 'port: 587', + ... 'starttls: yes', + ... 'username: rincewind', + ... 'password: 7ugg@g3', + ... ])) + >>> get_smtp_params(config) + ('smtp.mail.uu.edu', 587, True, 'rincewind', '7ugg@g3') + >>> config = ConfigParser() + >>> get_smtp_params(ConfigParser()) + (None, None, None, None, None) + """ + try: + host = config.get('smtp', 'host') + except _configparser.NoSectionError: + return (None, None, None, None, None) + except _configparser.NoOptionError: + host = None + try: + port = config.getint('smtp', 'port') + except _configparser.NoOptionError: + port = None + try: + starttls = config.getboolean('smtp', 'starttls') + except _configparser.NoOptionError: + starttls = None + try: + username = config.get('smtp', 'username') + except _configparser.NoOptionError: + username = None + try: + password = config.get('smtp', 'password') + except _configparser.NoOptionError: + password = None + return (host, port, starttls, username, password) + +def get_smtp(host=None, port=None, starttls=None, username=None, + password=None): + """Connect to an SMTP host using the given parameters. + + >>> import smtplib + >>> try: # doctest: +SKIP + ... smtp = get_smtp(host='smtp.gmail.com', port=587, starttls=True, + ... username='rincewind@uu.edu', password='7ugg@g3') + ... except smtplib.SMTPAuthenticationError as error: + ... print('that was not a real account') + that was not a real account + >>> smtp = get_smtp() # doctest: +SKIP + >>> smtp.quit() # doctest: +SKIP + """ + if host is None: + host = 'localhost' + if port is None: + port = _smtplib.SMTP_PORT + if username and not starttls: + raise ValueError( + 'sending passwords in the clear is unsafe! Use STARTTLS.') + LOG.info('connect to SMTP server at {}:{}'.format(host, port)) + smtp = _smtplib.SMTP(host=host, port=port) + smtp.ehlo() + if starttls: + smtp.starttls() + if username: + smtp.login(username, password) + #smtp.set_debuglevel(1) + return smtp + +def mail(message, smtp=None, sendmail=None): + """Send an email ``Message`` instance on its merry way. + + We can shell out to the user specified sendmail in case + the local host doesn't have an SMTP server set up + for easy ``smtplib`` usage. + + >>> message = encodedMIMEText('howdy!') + >>> message['From'] = 'John Doe ' + >>> message['To'] = 'Jack , Jill ' + >>> mail(message=message, sendmail=SENDMAIL) + """ + LOG.info('send message {} -> {}'.format(message['from'], message['to'])) + if smtp: + smtp.send_message(msg=message) + elif sendmail: + execute(sendmail, stdin=message.as_string().encode('us-ascii')) + else: + smtp = _smtplib.SMTP() + smtp.connect() + smtp.send_message(msg=message) + smtp.close() + +def header_from_text(text): + r"""Simple wrapper for instantiating a ``Message`` from text. + + >>> text = '\n'.join( + ... ['From: me@big.edu','To: you@big.edu','Subject: testing']) + >>> header = header_from_text(text=text) + >>> print(header.as_string()) # doctest: +REPORT_UDIFF + From: me@big.edu + To: you@big.edu + Subject: testing + + + """ + text = text.strip() + p = _Parser() + return p.parsestr(text, headersonly=True) + +def guess_encoding(text): + r""" + >>> guess_encoding('hi there') + 'us-ascii' + >>> guess_encoding('✉') + 'utf-8' + """ + for encoding in ['us-ascii', ENCODING, 'utf-8']: + try: + text.encode(encoding) + except UnicodeEncodeError: + pass + else: + return encoding + raise ValueError(text) + +def encodedMIMEText(body, encoding=None): + """Wrap ``MIMEText`` with ``guess_encoding`` detection. + + >>> message = encodedMIMEText('Hello') + >>> print(message.as_string()) # doctest: +REPORT_UDIFF + Content-Type: text/plain; charset="us-ascii" + MIME-Version: 1.0 + Content-Transfer-Encoding: 7bit + Content-Disposition: inline + + Hello + >>> message = encodedMIMEText('Джон Доу') + >>> print(message.as_string()) # doctest: +REPORT_UDIFF + Content-Type: text/plain; charset="utf-8" + MIME-Version: 1.0 + Content-Transfer-Encoding: base64 + Content-Disposition: inline + + 0JTQttC+0L0g0JTQvtGD + + """ + if encoding == None: + encoding = guess_encoding(body) + if encoding == 'us-ascii': + message = _MIMEText(body) + else: + # Create the message ('plain' stands for Content-Type: text/plain) + message = _MIMEText(body, 'plain', encoding) + message.add_header('Content-Disposition', 'inline') + return message + +def strip_bcc(message): + """Remove the Bcc field from a ``Message`` in preparation for mailing + + >>> message = encodedMIMEText('howdy!') + >>> message['To'] = 'John Doe ' + >>> message['Bcc'] = 'Jack , Jill ' + >>> message = strip_bcc(message) + >>> print(message.as_string()) # doctest: +REPORT_UDIFF + Content-Type: text/plain; charset="us-ascii" + MIME-Version: 1.0 + Content-Transfer-Encoding: 7bit + Content-Disposition: inline + To: John Doe + + howdy! + """ + del message['bcc'] + del message['resent-bcc'] + return message + +def append_text(text_part, new_text): + r"""Append text to the body of a ``plain/text`` part. + + Updates encoding as necessary. + + >>> message = encodedMIMEText('Hello') + >>> append_text(message, ' John Doe') + >>> print(message.as_string()) # doctest: +REPORT_UDIFF + Content-Type: text/plain; charset="us-ascii" + MIME-Version: 1.0 + Content-Disposition: inline + Content-Transfer-Encoding: 7bit + + Hello John Doe + >>> append_text(message, ', Джон Доу') + >>> print(message.as_string()) # doctest: +REPORT_UDIFF + MIME-Version: 1.0 + Content-Disposition: inline + Content-Type: text/plain; charset="utf-8" + Content-Transfer-Encoding: base64 + + SGVsbG8gSm9obiBEb2UsINCU0LbQvtC9INCU0L7Rgw== + + >>> append_text(message, ', and Jane Sixpack.') + >>> print(message.as_string()) # doctest: +REPORT_UDIFF + MIME-Version: 1.0 + Content-Disposition: inline + Content-Type: text/plain; charset="utf-8" + Content-Transfer-Encoding: base64 + + SGVsbG8gSm9obiBEb2UsINCU0LbQvtC9INCU0L7RgywgYW5kIEphbmUgU2l4cGFjay4= + + """ + original_encoding = text_part.get_charset().input_charset + original_payload = str( + text_part.get_payload(decode=True), original_encoding) + new_payload = '{}{}'.format(original_payload, new_text) + new_encoding = guess_encoding(new_payload) + if text_part.get('content-transfer-encoding', None): + # clear CTE so set_payload will set it properly for the new encoding + del text_part['content-transfer-encoding'] + text_part.set_payload(new_payload, new_encoding) + +def attach_root(header, root_part): + r"""Copy headers from ``header`` onto ``root_part``. + + >>> header = header_from_text('From: me@big.edu\n') + >>> body = encodedMIMEText('Hello') + >>> message = attach_root(header, body) + >>> print(message.as_string()) # doctest: +REPORT_UDIFF + Content-Type: text/plain; charset="us-ascii" + MIME-Version: 1.0 + Content-Transfer-Encoding: 7bit + Content-Disposition: inline + From: me@big.edu + + Hello + """ + for k,v in header.items(): + root_part[k] = v + return root_part + +def execute(args, stdin=None, expect=(0,), env=_os.environ): + """Execute a command (allows us to drive gpg). + """ + LOG.debug('$ {}'.format(args)) + try: + p = _subprocess.Popen( + args, stdin=_subprocess.PIPE, stdout=_subprocess.PIPE, + stderr=_subprocess.PIPE, shell=False, close_fds=True, env=env) + except OSError as e: + raise Exception('{}\nwhile executing {}'.format(e.args[1], args)) + output,error = p.communicate(input=stdin) + status = p.wait() + LOG.debug('(status: {})\n{}{}'.format(status, output, error)) + if status not in expect: + raise Exception('unexpected status while executing {}\n{}\n{}'.format( + args, error, status)) + return (status, output, error) + +def getaddresses(addresses): + """A decoding version of ``email.utils.getaddresses``. + + >>> text = ('To: =?utf-8?b?0JTQttC+0L0g0JTQvtGD?= , ' + ... 'Jack ') + >>> header = header_from_text(text=text) + >>> list(getaddresses(header.get_all('to', []))) + [('Джон Доу', 'jdoe@a.gov.ru'), ('Jack', 'jack@hill.org')] + """ + for (name,address) in _getaddresses(addresses): + n = [] + for b,encoding in _decode_header(name): + if encoding is None: + n.append(b) + else: + n.append(str(b, encoding)) + yield (' '.join(n), address) + +def email_sources(message): + """Extract author address from an email ``Message`` + + Search the header of an email Message instance to find the + senders' email addresses (or sender's address). + + >>> text = ('From: =?utf-8?b?0JTQttC+0L0g0JTQvtGD?= , ' + ... 'Jack ') + >>> header = header_from_text(text=text) + >>> list(email_sources(header)) + [('Джон Доу', 'jdoe@a.gov.ru'), ('Jack', 'jack@hill.org')] + """ + froms = message.get_all('from', []) + return getaddresses(froms) # [(name, address), ...] + +def email_targets(message): + """Extract recipient addresses from an email ``Message`` + + Search the header of an email Message instance to find a + list of recipient's email addresses. + + >>> text = ('To: =?utf-8?b?0JTQttC+0L0g0JTQvtGD?= , ' + ... 'Jack ') + >>> header = header_from_text(text=text) + >>> list(email_targets(header)) + [('Джон Доу', 'jdoe@a.gov.ru'), ('Jack', 'jack@hill.org')] + """ + tos = message.get_all('to', []) + ccs = message.get_all('cc', []) + bccs = message.get_all('bcc', []) + resent_tos = message.get_all('resent-to', []) + resent_ccs = message.get_all('resent-cc', []) + resent_bccs = message.get_all('resent-bcc', []) + return getaddresses( + tos + ccs + bccs + resent_tos + resent_ccs + resent_bccs) + +def sign_bytes(bytes, sign_as=None): + r"""Sign ``bytes`` as ``sign_as``. + + >>> print(sign_bytes(bytes(b'Hello'), 'wking@drexel.edu')) + ... # doctest: +ELLIPSIS + b'-----BEGIN PGP SIGNATURE-----\n...-----END PGP SIGNATURE-----\n' + """ + args = GPG_ARGS + GPG_SIGN_ARGS + if sign_as: + args.extend(['--local-user', sign_as]) + status,output,error = execute(args, stdin=bytes) + return output + +def encrypt_bytes(bytes, recipients): + r"""Encrypt ``bytes`` to ``recipients``. + + >>> encrypt_bytes(bytes(b'Hello'), ['wking@drexel.edu']) + ... # doctest: +ELLIPSIS + b'-----BEGIN PGP MESSAGE-----\n...-----END PGP MESSAGE-----\n' + """ + args = GPG_ARGS + GPG_ENCRYPT_ARGS + if not recipients: + raise ValueError('no recipients specified for encryption') + for recipient in recipients: + args.extend(['--recipient', recipient]) + status,output,error = execute(args, stdin=bytes) + return output + +def sign_and_encrypt_bytes(bytes, sign_as=None, recipients=None): + r"""Sign ``bytes`` as ``sign_as`` and encrypt to ``recipients``. + + >>> sign_and_encrypt_bytes( + ... bytes(b'Hello'), 'wking@drexel.edu', ['wking@drexel.edu']) + ... # doctest: +ELLIPSIS + b'-----BEGIN PGP MESSAGE-----\n...-----END PGP MESSAGE-----\n' + """ + args = GPG_ARGS + GPG_SIGN_AND_ENCRYPT_ARGS + if sign_as: + args.extend(['--local-user', sign_as]) + if not recipients: + raise ValueError('no recipients specified for encryption') + for recipient in recipients: + args.extend(['--recipient', recipient]) + status,output,error = execute(args, stdin=bytes) + return output + +def sign(message, sign_as=None): + r"""Sign a ``Message``, returning the signed version. + + multipart/signed + +-> text/plain (body) + +-> application/pgp-signature (signature) + + >>> message = encodedMIMEText('Hi\nBye') + >>> signed = sign(message, sign_as='0xFC29BDCDF15F5BE8') + >>> signed.set_boundary('boundsep') + >>> print(signed.as_string()) # doctest: +ELLIPSIS, +REPORT_UDIFF + Content-Type: multipart/signed; protocol="application/pgp-signature"; micalg="pgp-sha1"; boundary="boundsep" + MIME-Version: 1.0 + Content-Disposition: inline + + --boundsep + Content-Type: text/plain; charset="us-ascii" + MIME-Version: 1.0 + Content-Transfer-Encoding: 7bit + Content-Disposition: inline + + Hi + Bye + --boundsep + MIME-Version: 1.0 + Content-Transfer-Encoding: 7bit + Content-Description: OpenPGP digital signature + Content-Type: application/pgp-signature; name="signature.asc"; charset="us-ascii" + + -----BEGIN PGP SIGNATURE----- + Version: GnuPG... + -----END PGP SIGNATURE----- + + --boundsep-- + + >>> from email.mime.multipart import MIMEMultipart + >>> message = MIMEMultipart() + >>> message.attach(encodedMIMEText('Part A')) + >>> message.attach(encodedMIMEText('Part B')) + >>> signed = sign(message, sign_as='0xFC29BDCDF15F5BE8') + >>> signed.set_boundary('boundsep') + >>> print(signed.as_string()) # doctest: +ELLIPSIS, +REPORT_UDIFF + Content-Type: multipart/signed; protocol="application/pgp-signature"; micalg="pgp-sha1"; boundary="boundsep" + MIME-Version: 1.0 + Content-Disposition: inline + + --boundsep + Content-Type: multipart/mixed; boundary="===============...==" + MIME-Version: 1.0 + + --===============...== + Content-Type: text/plain; charset="us-ascii" + MIME-Version: 1.0 + Content-Transfer-Encoding: 7bit + Content-Disposition: inline + + Part A + --===============...== + Content-Type: text/plain; charset="us-ascii" + MIME-Version: 1.0 + Content-Transfer-Encoding: 7bit + Content-Disposition: inline + + Part B + --===============...==-- + --boundsep + MIME-Version: 1.0 + Content-Transfer-Encoding: 7bit + Content-Description: OpenPGP digital signature + Content-Type: application/pgp-signature; name="signature.asc"; charset="us-ascii" + + -----BEGIN PGP SIGNATURE----- + Version: GnuPG... + -----END PGP SIGNATURE----- + + --boundsep-- + """ + body = message.as_string().encode('us-ascii') + signature = str(sign_bytes(body, sign_as), 'us-ascii') + sig = _MIMEApplication( + _data=signature, + _subtype='pgp-signature; name="signature.asc"', + _encoder=_encode_7or8bit) + sig['Content-Description'] = 'OpenPGP digital signature' + sig.set_charset('us-ascii') + + msg = _MIMEMultipart( + 'signed', micalg='pgp-sha1', protocol='application/pgp-signature') + msg.attach(message) + msg.attach(sig) + msg['Content-Disposition'] = 'inline' + return msg + +def encrypt(message, recipients=None): + r"""Encrypt a ``Message``, returning the encrypted version. + + multipart/encrypted + +-> application/pgp-encrypted (control information) + +-> application/octet-stream (body) + + >>> message = encodedMIMEText('Hi\nBye') + >>> message['To'] = '"W. Trevor King" ' + >>> encrypted = encrypt(message) + >>> encrypted.set_boundary('boundsep') + >>> print(encrypted.as_string()) # doctest: +ELLIPSIS, +REPORT_UDIFF + Content-Type: multipart/encrypted; protocol="application/pgp-encrypted"; micalg="pgp-sha1"; boundary="boundsep" + MIME-Version: 1.0 + Content-Disposition: inline + + --boundsep + MIME-Version: 1.0 + Content-Transfer-Encoding: 7bit + Content-Type: application/pgp-encrypted; charset="us-ascii" + + Version: 1 + + --boundsep + MIME-Version: 1.0 + Content-Transfer-Encoding: 7bit + Content-Description: OpenPGP encrypted message + Content-Type: application/octet-stream; name="encrypted.asc"; charset="us-ascii" + + -----BEGIN PGP MESSAGE----- + Version: GnuPG... + -----END PGP MESSAGE----- + + --boundsep-- + + >>> from email.mime.multipart import MIMEMultipart + >>> message = MIMEMultipart() + >>> message.attach(encodedMIMEText('Part A')) + >>> message.attach(encodedMIMEText('Part B')) + >>> encrypted = encrypt(message, recipients=['F15F5BE8']) + >>> encrypted.set_boundary('boundsep') + >>> print(encrypted.as_string()) # doctest: +ELLIPSIS, +REPORT_UDIFF + Content-Type: multipart/encrypted; protocol="application/pgp-encrypted"; micalg="pgp-sha1"; boundary="boundsep" + MIME-Version: 1.0 + Content-Disposition: inline + + --boundsep + MIME-Version: 1.0 + Content-Transfer-Encoding: 7bit + Content-Type: application/pgp-encrypted; charset="us-ascii" + + Version: 1 + + --boundsep + MIME-Version: 1.0 + Content-Transfer-Encoding: 7bit + Content-Description: OpenPGP encrypted message + Content-Type: application/octet-stream; name="encrypted.asc"; charset="us-ascii" + + -----BEGIN PGP MESSAGE----- + Version: GnuPG... + -----END PGP MESSAGE----- + + --boundsep-- + """ + body = message.as_string().encode('us-ascii') + if recipients is None: + recipients = [email for name,email in email_targets(message)] + LOG.debug('extracted encryption recipients: {}'.format(recipients)) + encrypted = str(encrypt_bytes(body, recipients), 'us-ascii') + enc = _MIMEApplication( + _data=encrypted, + _subtype='octet-stream; name="encrypted.asc"', + _encoder=_encode_7or8bit) + enc['Content-Description'] = 'OpenPGP encrypted message' + enc.set_charset('us-ascii') + control = _MIMEApplication( + _data='Version: 1\n', + _subtype='pgp-encrypted', + _encoder=_encode_7or8bit) + control.set_charset('us-ascii') + msg = _MIMEMultipart( + 'encrypted', + micalg='pgp-sha1', + protocol='application/pgp-encrypted') + msg.attach(control) + msg.attach(enc) + msg['Content-Disposition'] = 'inline' + return msg + +def sign_and_encrypt(message, sign_as=None, recipients=None): + r"""Sign and encrypt a ``Message``, returning the encrypted version. + + multipart/encrypted + +-> application/pgp-encrypted (control information) + +-> application/octet-stream (body) + + >>> message = encodedMIMEText('Hi\nBye') + >>> message['To'] = '"W. Trevor King" ' + >>> encrypted = sign_and_encrypt(message) + >>> encrypted.set_boundary('boundsep') + >>> print(encrypted.as_string()) # doctest: +ELLIPSIS, +REPORT_UDIFF + Content-Type: multipart/encrypted; protocol="application/pgp-encrypted"; micalg="pgp-sha1"; boundary="boundsep" + MIME-Version: 1.0 + Content-Disposition: inline + + --boundsep + MIME-Version: 1.0 + Content-Transfer-Encoding: 7bit + Content-Type: application/pgp-encrypted; charset="us-ascii" + + Version: 1 + + --boundsep + MIME-Version: 1.0 + Content-Transfer-Encoding: 7bit + Content-Description: OpenPGP encrypted message + Content-Type: application/octet-stream; name="encrypted.asc"; charset="us-ascii" + + -----BEGIN PGP MESSAGE----- + Version: GnuPG... + -----END PGP MESSAGE----- + + --boundsep-- + + >>> from email.mime.multipart import MIMEMultipart + >>> message = MIMEMultipart() + >>> message.attach(encodedMIMEText('Part A')) + >>> message.attach(encodedMIMEText('Part B')) + >>> encrypted = sign_and_encrypt(message, recipients=['F15F5BE8']) + >>> encrypted.set_boundary('boundsep') + >>> print(encrypted.as_string()) # doctest: +ELLIPSIS, +REPORT_UDIFF + Content-Type: multipart/encrypted; protocol="application/pgp-encrypted"; micalg="pgp-sha1"; boundary="boundsep" + MIME-Version: 1.0 + Content-Disposition: inline + + --boundsep + MIME-Version: 1.0 + Content-Transfer-Encoding: 7bit + Content-Type: application/pgp-encrypted; charset="us-ascii" + + Version: 1 + + --boundsep + MIME-Version: 1.0 + Content-Transfer-Encoding: 7bit + Content-Description: OpenPGP encrypted message + Content-Type: application/octet-stream; name="encrypted.asc"; charset="us-ascii" + + -----BEGIN PGP MESSAGE----- + Version: GnuPG... + -----END PGP MESSAGE----- + + --boundsep-- + """ + strip_bcc(message=message) + body = message.as_string().encode('us-ascii') + if recipients is None: + recipients = [email for name,email in email_targets(message)] + LOG.debug('extracted encryption recipients: {}'.format(recipients)) + encrypted = str(sign_and_encrypt_bytes( + body, sign_as=sign_as, recipients=recipients), 'us-ascii') + enc = _MIMEApplication( + _data=encrypted, + _subtype='octet-stream; name="encrypted.asc"', + _encoder=_encode_7or8bit) + enc['Content-Description'] = 'OpenPGP encrypted message' + enc.set_charset('us-ascii') + control = _MIMEApplication( + _data='Version: 1\n', + _subtype='pgp-encrypted', + _encoder=_encode_7or8bit) + control.set_charset('us-ascii') + msg = _MIMEMultipart( + 'encrypted', + micalg='pgp-sha1', + protocol='application/pgp-encrypted') + msg.attach(control) + msg.attach(enc) + msg['Content-Disposition'] = 'inline' + return msg diff --git a/setup.py b/setup.py new file mode 100644 index 0000000..9f44165 --- /dev/null +++ b/setup.py @@ -0,0 +1,37 @@ +# Copyright (C) 2012 W. Trevor King + +"Tools for dealing with Pretty Good Privacy (PGP) and email." + +from distutils.core import setup as _setup +import os.path as _os_path + +from pgp_mime import __version__ + + +_this_dir = _os_path.dirname(__file__) + +_setup( + name='pgp-mime', + version=__version__, + maintainer='W. Trevor King', + maintainer_email='wking@drexel.edu', + url='http://blog.tremily.us/posts/pgp-mime/', + download_url='http://git.tremily.us/?p=pgp-mime.git;a=snapshot;h=v{};sf=tgz'.format(__version__), + license = 'GNU General Public License (GPL)', + platforms = ['all'], + description = __doc__, + long_description=open(_os_path.join(_this_dir, 'README'), 'r').read(), + classifiers = [ + 'Development Status :: 3 - Alpha', + 'Intended Audience :: Developers', + 'Operating System :: OS Independent', + 'License :: OSI Approved :: GNU General Public License (GPL)', + 'Programming Language :: Python :: 3', + 'Topic :: Communications :: Email', + 'Topic :: Security :: Cryptography', + 'Topic :: Software Development' + ], + scripts = ['bin/send-pgp-mime.py'], + py_modules = ['pgp_mime'], + provides = ['pgp_mime'], + )