Repository: MLstate/PEPS Branch: master Commit: b7a95f810896 Files: 34 Total size: 86.2 KB Directory structure: gitextract_mf63pe6x/ ├── .gitignore ├── BUILD.md ├── CONTRIBUTING.md ├── LICENSE.html ├── Makefile ├── README.md ├── hostname ├── mongod/ │ └── Dockerfile ├── opa/ │ └── Dockerfile ├── peps/ │ ├── Dockerfile │ └── peps.sh ├── scripts/ │ └── python/ │ ├── README.md │ ├── import.py │ ├── test.py │ ├── utils.py │ └── webmail.py ├── smtpin/ │ ├── Dockerfile │ ├── config/ │ │ ├── databytes │ │ ├── loglevel │ │ ├── plugins │ │ ├── smtp.ini │ │ └── smtpin.ini │ ├── haraka.sh │ ├── package.json │ └── plugins/ │ └── smtpin.js ├── smtpout/ │ ├── Dockerfile │ ├── config/ │ │ ├── databytes │ │ ├── loglevel │ │ ├── plugins │ │ └── smtp.ini │ ├── haraka.sh │ ├── package.json │ └── plugins/ │ └── smtpout.js └── solr/ └── Dockerfile ================================================ FILE CONTENTS ================================================ ================================================ FILE: .gitignore ================================================ domain scripts/python/config.py server.crt server.csr server.key* ================================================ FILE: BUILD.md ================================================ PEPS is free/libre and open source software written in [Opa](http://opalang.org). Provided the dependencies are met, to build from source, run: ```sh git clone https://github.com/MLstate/PEPS-source cd PEPS-source # Compile make # Run ./peps.exe ``` Read more about dependencies at the [PEPS-source](https://github.com/MLstate/PEPS-source) repository. ================================================ FILE: CONTRIBUTING.md ================================================ PEPS needs contributors, so thanks for considering contributing. # Repositories and CLA Note that there are two repositories: This one with the distribution definition and configuration (Docker containers) and [the application source](https://github.com/MLstate/PEPS-source). The reason is that you don't need to clone the source when deploying servers. To get started, sign the Contributor License Agreement. The CLA is directly adapted from the Apache Foundation CLA and does *not* require you to assign copyright of your contributions. Then, fork the repository and submit pull requests. They will be reviewed before merging. # PEPS design Please read the corresponding [wiki page](https://github.com/MLstate/PEPS/wiki/PEPS-Design-Document). Thank you! ================================================ FILE: LICENSE.html ================================================ GNU Affero General Public License

GNU AFFERO GENERAL PUBLIC LICENSE

Version 3, 19 November 2007

Copyright © 2007 Free Software Foundation, Inc. <http://fsf.org/>
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 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 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:

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.

================================================ FILE: Makefile ================================================ # PEPS deployment based on Docker containers # (c) 2014-2015 MLstate HOSTNAME?=$(shell cat hostname) DOMAIN_NAME=$(shell cat domain) MONGO_DATA ?= /data/db SOLR_DATA ?= /data/solr # On MacOS, use /private/etc/peps to keep configuration in /etc PEPS_ETC ?= /etc/peps # Public ports HTTPS_PORT?=443 SMTP_PORT?=25 SMTPS_PORT?=587 SMTPSBIS_PORT?=465 # Handy if you need --no-cache=true DOCKER_BUILD_OPTS?= DOCKER_DAEMON=docker run -d -h $(HOSTNAME) default: @echo "PEPS" @echo "Write the server domain name to a file named 'domain' and then:" @echo "- make build: build docker containers" @echo "- make certificate: generate self-signed SSL certificate" @echo " (or copy your own to server.key and server.crt)" @echo "- make run: run docker containers" @echo "---" @echo "make start/stop/kill/rm" certificate: openssl genrsa -des3 -out server.key 1024 openssl req -new -key server.key -out server.csr cp server.key server.key.org openssl rsa -in server.key.org -out server.key # strip passphrase openssl x509 -req -days 365 -in server.csr -signkey server.key -out server.crt install_cert: server.key server.crt cp -a server.key server.crt $(PEPS_ETC) build: domain cd mongod; docker build $(DOCKER_BUILD_OPTS) -t mongod . cd opa; docker build $(DOCKER_BUILD_OPTS) -t opa . cd peps; docker build $(DOCKER_BUILD_OPTS) -t peps . cd solr; docker build $(DOCKER_BUILD_OPTS) -t solr . cp domain smtpin/ cd smtpin; docker build $(DOCKER_BUILD_OPTS) -t smtpin . cp domain smtpout/ cd smtpout; docker build $(DOCKER_BUILD_OPTS) -t smtpout . data_init: mkdir -p $(SOLR_DATA)/peps_mail $(SOLR_DATA)/peps_file $(SOLR_DATA)/peps_user $(SOLR_DATA)/peps_contact mkdir -p $(MONGO_DATA) mkdir -p $(PEPS_ETC) cp domain $(PEPS_ETC) run: data_init install_cert $(DOCKER_DAEMON) --name peps_mongod -v $(MONGO_DATA):/data/db:rw mongod $(DOCKER_DAEMON) --name peps_solr -v $(SOLR_DATA):/solr_data:rw solr $(DOCKER_DAEMON) --name peps_smtpout -p $(SMTPSBIS_PORT):$(SMTPSBIS_PORT) -v $(PEPS_ETC):/etc/peps:ro smtpout $(DOCKER_DAEMON) --name peps_server -p $(HTTPS_PORT):$(HTTPS_PORT) -v $(PEPS_ETC):/etc/peps:ro --link=peps_mongod:mongod --link=peps_solr:solr --link=peps_smtpout:smtpout peps $(DOCKER_DAEMON) --name peps_smtpin -p $(SMTP_PORT):$(SMTP_PORT) -v $(PEPS_ETC):/etc/peps:ro -p $(SMTPS_PORT):$(SMTPS_PORT) --link peps_server:peps smtpin @echo Now open your browser and log in to https://$(HOSTNAME) @echo At first launch, you will set up your admin password start: docker start peps_mongod peps_solr peps_smtpout peps_server peps_smtpin stop: docker stop peps_smtpin peps_server peps_mongod peps_solr peps_smtpout kill: docker kill peps_smtpin peps_server peps_mongod peps_solr peps_smtpout rm: docker rm peps_smtpin peps_server peps_mongod peps_solr peps_smtpout rmi_peps: docker rmi peps # Update the peps_server container update: stop rm rmi_peps build run ================================================ FILE: README.md ================================================ **Warning: This product is not maintained!** **Following the acquisition of MLstate by WALLIX, the core technology of PEPS has become [DataPeps](https://datapeps.com), a generic E2EE framework that can be integrated in any application.** The content below is kept as a reference, please do not use the following code and project. PEPS ==== PEPS was an innovative open source email and collaboration server. Main Features | ------------- | Clean UX/UI | Messages | File sharing | Newsfeed | Client-side encryption | New internal message protocol | Extensible | RESTful APIs | Powered by Node.js | Data in MongoDB | Open Source | This open source portal enables you to download and install PEPS on your own server. # Why PEPS? PEPS is an open source email, file sharing and collaboration server that intends to fullfil the need for high-quality on-premises software that could rival with top-notch SaaS products such as Gmail or Dropbox, and innovate with new features. PEPS is built to be extensible thanks to complete APIs and we aim at creating an ecosystem of compatible apps and services. Please read more [about PEPS](http://github.com/MLstate/PEPS/wiki/About) and its [roadmap](http://github.com/MLstate/PEPS/wiki/Roadmap). We also have a [FAQ](http://github.com/MLstate/PEPS/wiki/FAQ). This repository contains the source of the PEPS containers. [PEPS application source](https://github.com/MLstate/PEPS-source) is available from a [separate repository](https://github.com/MLstate/PEPS-source) under the Affero GPL License. # Installation guide The deployment of a single PEPS server is made easy with [Docker](http://docker.io). You should have your server up and running in 30 minutes. PEPS uses technologies that can scale up, but this will require some more work or you can [contact our company](mailto:contact@mlstate.com). ## Docker containers First install Docker on your server. If you are new to Docker, you can use Docker-ready linux instances at [DigitalOcean](https://www.digitalocean.com/community/tutorials/how-to-run-your-own-mail-server-and-file-storage-with-peps-on-ubuntu-14-04) or similar services. **You must have at least 2 Gb RAM for your PEPS instance**. To build the Docker containers and run on a Docker instance, just type: ```sh # Just in case, install make apt-get install make # Clone the repository git clone https://github.com/MLstate/PEPS cd PEPS # Configure your domain name echo YOUR_DOMAIN_NAME > domain # Build the containers make build make certificate # or install existing certificates server.key and server.crt # Run the containers make run ``` To later stop, start and remove containers, you can use: ```sh make stop make start make rm ``` ## System Configuration PEPS runs by default using HTTPS. The only major pre-requisites are that you should have installed server.crt and server.key in the `$(PEPS_ETC)` directory (by default `/etc/peps`) which is shared by several containers. If you want to start quickly with a self-signed certificate, type: ```sh make certificate ``` before running `make run`. Note that the same certificates are used for the HTTPS server and the SMTPS services. ## PEPS Configuration You should now be able to run the PEPS server at `https://YOUR_DOMAIN_NAME` and connect to it, you then need to: 1. Set up the 'admin' password at first launch and accept the license 2. Head to the "Users" tab in the topbar 3. Create users, teams, and go! # Documentation Manuals for both users and admins are available in form of the PEPS wiki: - [User Manual](http://github.com/MLstate/PEPS/wiki/User-Manual) - [Admin Manual](http://github.com/MLstate/PEPS/wiki/Admin-Manual) - [Developer Manual](http://github.com/MLstate/PEPS/wiki/Developer-Manual) - [Operator Manual](https://github.com/MLstate/PEPS/wiki/Operator-Manual) # Twitter contacts - Project created by [@henri_opa](https://twitter.com/henri_opa) at [MLstate](http://mlstate.com) - Design/UX by [@tweetfr](https://twitter.com/tweetfr) - Main developers: [henrichataing](https://github.com/henrichataing), [Aqua-Ye](https://github.com/Aqua-Ye), [cedricss](https://github.com/cedricss), [matbd](https://github.com/matbd), [nrs135](https://github.com/nrs135) ================================================ FILE: hostname ================================================ localhost ================================================ FILE: mongod/Dockerfile ================================================ # MongoDB container FROM phusion/baseimage:0.10.1 # Add 10gen official apt source to the sources list. RUN apt-key adv --keyserver hkp://keyserver.ubuntu.com:80 --recv 7F0CEB10 RUN echo 'deb http://downloads-distro.mongodb.org/repo/ubuntu-upstart dist 10gen' | tee /etc/apt/sources.list.d/10gen.list # Install MongoDB. RUN apt-get update && apt-get install -y \ mongodb-org-server \ mongodb-org-shell \ mongodb-org-tools \ mongodb-org-mongos # Bodge for missing "node" executable #RUN ln -s /usr/bin/nodejs /usr/bin/node #RUN /usr/bin/npm install -g forever # Run the mongo daemon. EXPOSE 27017 CMD ["/usr/bin/mongod", \ "--port","27017", \ "--smallfiles", \ "--dbpath","/data/db", \ "--logpath","/mongo.log"] ================================================ FILE: opa/Dockerfile ================================================ # Generic Opa container FROM phusion/baseimage:0.10.1 # Install stuff we need RUN apt-get update && apt-get install -y \ curl \ unzip \ nodejs \ npm # Bodge for missing "node" executable RUN ln -s /usr/bin/nodejs /usr/bin/node # Download the opa libs RUN curl -sf -o /tmp/opa.zip -L https://github.com/MLstate/PEPS/releases/download/0.9.9/opa.zip RUN mkdir -p /opa && cd /opa && unzip -q /tmp/opa.zip # Point opa to our downloaded libraries ENV OPADIR /opa/usr/local/lib/opa ENV NODE_PATH $OPADIR/static:$OPADIR/stdlib:$OPADIR/stdlib/stdlib.qmljs:/usr/local/lib/node_modules:node_modules: ================================================ FILE: peps/Dockerfile ================================================ # The main peps container # Based on our generic opa container which has mlstatelibs and node built in. FROM opa:latest # Download the peps executable RUN curl -sf -o /tmp/peps.zip -L https://github.com/MLstate/PEPS/releases/download/0.9.9/peps.zip RUN mkdir -p /peps && cd /peps && unzip -q /tmp/peps.zip RUN rm /tmp/peps.zip RUN /usr/bin/npm install -g \ ursa \ simplesmtp \ rai \ nodemailer@2.7.2 \ ldapjs \ iconv \ nodemailer-smtp-transport@2.7.2 \ mailparser@0.6.2 \ html-to-text \ tweetnacl@0.13.3 \ intl-messageformat intl@0.1.4 # We need to add the webmail modules to the node path ENV NODE_PATH $NODE_PATH:/peps/_build # Get configuration data VOLUME ["/etc/peps"] # ADD ../domain /etc/peps/domain # FIXME: SMTP out # EXPOSE 25 EXPOSE 443 # SMTP in port EXPOSE 8999 # Add startup scripts (or to /etc/service/peps?) ADD peps.sh /etc/my_init.d/10peps.sh # Start the init daemon CMD ["/sbin/my_init"] ================================================ FILE: peps/peps.sh ================================================ #!/bin/sh /peps/opa_webmail.exe \ --http-server-port 443 \ --db-remote:webmail $MONGOD_PORT_27017_TCP_ADDR:$MONGOD_PORT_27017_TCP_PORT \ --db-remote:rawdata $MONGOD_PORT_27017_TCP_ADDR:$MONGOD_PORT_27017_TCP_PORT \ --db-remote:sessions $MONGOD_PORT_27017_TCP_ADDR:$MONGOD_PORT_27017_TCP_PORT \ --db-remote:tokens $MONGOD_PORT_27017_TCP_ADDR:$MONGOD_PORT_27017_TCP_PORT \ --solr-addr $SOLR_PORT_8983_TCP_ADDR --solr-port $SOLR_PORT_8983_TCP_PORT \ --smtp-out-host $SMTPOUT_PORT_25_TCP_ADDR \ --smtp-out-port $SMTPOUT_PORT_25_TCP_PORT # Deprecated parameters. # --smtp-server-port 25 --smtp-server-auth "" \ # --smtp-secure false --smtp-auth "" \ # To run as HTTP instead of HTTPS # --no-ssl true # To enable SMTP debug # --smtp-debug true \ ================================================ FILE: scripts/python/README.md ================================================ % IMAP import tool # Introduction The python script [imap.py](https://github.com/MLstate/applications/blob/alpha/webmail/import-tool/imap.py) implements a binding to the REST api of webmail, as well as helper functions to import existing mail boxes using IMAP protocol. # Sample usage ./imap.py upload -c 1000 # Configuration Configuration is put in a python script `config.py` in the same directory, with the following variables defined: ``` python # IMAP imap_server = 'imap.gmail.com' mail_address = 'ann.onymous@gmail.com' # OAuth consumer_key = '123' consumer_secret = '456' ``` All the fields are optional, and undefined values will be prompted at runtime. # Command line API functions can be manually accessed through the Python console as well. To launch the console: ``` bash python3 -i imap.py ``` If the configuration file `config.py` is present, its values will be imported. API methods are accessed through a WebmailAPI object, which manages the connection parameters and pre-formats some of the requests' inputs. For example: ``` >>> webmail = WebmailApi() .. >>> webmail.folder_list() [{'name': 'Inbox', 'id': 'INBOX'}, {'name': 'Starred', 'id': 'STARRED'}, ...] ``` WebmailApi() implements two distinct methods of connecting to the API: * If you possess a pair of `consumer_key`, `consumer_secret`, you can either add them to `config.py` or enter them as requested. The connection will then follow the standard OAuth1 connection flow. * Else, you can connect to PEPS using your usual `username` and `password`, as requested by a prompt. The created object can be used exactly the same after the initial configuration. # Dependencies Install Python3 and dependencies: chardet, rauth and flask. For instance, on OSX: ```bash brew install python3 pip3 install chardet rauth flask ``` ================================================ FILE: scripts/python/import.py ================================================ #! /usr/bin/env python3.4 # Author: Henri Binsztok # cf. http://stackoverflow.com/questions/3173320/text-progress-bar-in-the-console import os, sys, getopt, argparse import re, getpass import time from queue import Queue import tokenize import unittest import imaplib, requests, mimetypes imaplib._MAXLINE = 40000 import email, json import chardet, base64, quopri from email.parser import HeaderParser from email.header import decode_header hparser = HeaderParser() email_pattern = re.compile(r'\b[A-Z0-9._%+-]+@[A-Z0-9.-]+\.[A-Z]{2,4}\b', re.IGNORECASE) from rauth import OAuth1Service, OAuth1Session from flask import Flask, request, g from multiprocessing import Process, Array, Manager import ctypes # from OpenSSL import SSL import webbrowser from utils import varconfig, timed from webmail import WebmailApi, ApiError ######### GENERAL CONFIGURATION ############# CHARDET_MINCONF = 0.8 QP_SUPPORTED = False ################ MAIL IMPORT ################ # Argument parser. parser = argparse.ArgumentParser(description='Import mails to PEPS.') parser.add_argument( '-c', '--cmax', metavar='cmax', type=int, nargs='?', const=None, default=None, help='the number of mails to import (all by default)') parser.add_argument( '-b', '--box', metavar='cmax', nargs='*', default=['inbox'], help='specifies boxes to import (defaults to "inbox")') # Establish connection with IMAP server. def imap(): server = varconfig('imap_server', 'IMAP server: ') address = varconfig('mail_address', 'Address: ') password = getpass.getpass('Password: ') mail = imaplib.IMAP4_SSL(server) mail.login(address, password) return mail # Decode an incoming byte string (guessing the encoding using chardet), and # encode it again in a request compatible string (latin-1). def _decode(raw): enc = chardet.detect(raw) # Detect encoding. data = '' cte = 'binary' if enc['encoding'] != 'ascii' and enc['encoding'] != 'latin-1': if QP_SUPPORTED: data = quopri.encodestring(raw).decode('latin-1') cte = 'quotable-printable' else: data = base64.b64encode(raw).decode('latin-1') cte = 'base64' else: data = raw.decode(enc['encoding']) return data, cte # Retrieve the latest mail in the box and uploads it through the API. # @param cmax the number of mails to upload. If None, all the mails are imported. def upload_box(mail, api, cmax=None): result, data = mail.search(None, "ALL") if result == 'OK': ids = data[0].split() # Ids is a space separated string. ids.reverse() if cmax is None: cmax = len(ids) else: cmax = min(cmax, len(ids)) i = 0 tfetch = 0 tupload = 0 print('0.0 %', end='') for id in ids[:cmax]: # Fetch raw message. (result, data), elapsed = timed(mail.fetch, id, "(RFC822)") # fetch the email body (RFC822) for the given ID. tfetch += elapsed # Encode. raw = data[0][1] # Raw mail, in bytes. data, cte = _decode(raw) # Upload into API. try: result, elapsed = timed(api.message_insert, 'media', data, cte) tupload += elapsed except ApiError as err: print('\nFailed to upload one message: {}\n'.format(err)) # Progress. i = i+1 percent = i * 100 / cmax print('\r\033[0K{0:.2f} %'.format(percent), end='') print('\r\033[0KDone.\n-- fetch time: {}\n-- upload time {}'.format(tfetch, tupload)) else: print('Could not access the mail box: {}'.format(result)) # Upload the last mail the given number of times (performance test). def upload_test(mail, api, cmax=None): result, data = mail.search(None, "ALL") cmax = cmax or 1000 if result == 'OK': ids = data[0].split() # Ids is a space separated string. result, data = mail.fetch(ids[-1], "(RFC822)") # fetch the email body (RFC822) for the last mail ID. raw = data[0][1] # Raw mail, in bytes. data, cte = _decode(raw) print('0.0 %', end='') for i in range(cmax): # Upload into Api. api.message_insert('media', data, cte) # Progress. i = i+1 percent = i * 100 / cmax print('\r\033[0K{0:.2f} %'.format(percent), end='') print('\r\033[0KDone.') else: print('Could not access the mail box: {}'.format(result)) # Run either of the commands. def _run(argv, func): try: args = parser.parse_args(argv) mail = imap() api = WebmailApi() boxes = args.box cmax = args.cmax for box in boxes: print('Uploading "{}"'.format(box)) mail.select(box) func(mail, api, cmax=cmax) except imaplib.IMAP4.error: print('Unable to establish connection with the server') return None # Parse command line arguments. def upload(argv): _run(argv, upload_box) # Run an upload test. def test(argv): _run(argv, upload_test) ############### FILE IMPORT ################# # Upload the contents of a local folder through the file API. def upload_dir(path, where, api, rec=False): # Contains the list of files to upload. queue = Queue() # Pop an element from the queue, and deal with it. def upload(rec): (path, where) = queue.get() if os.path.isdir(path) and rec: files = os.listdir(path=path) for f in files: queue.put((path+'/'+f, where+'/'+f)) elif os.path.isfile(path): try: mimetype, encoding = mimetypes.guess_type(path) mimetype = mimetype or 'application/octet-stream' raw = open(path, mode='rb').read() data, cte = _decode(raw) api.file_upload(where, data, mimetype, cte) except Exception as err: print('Failed to upload file {}: {}'.format(path, err)) # Initialize the queue, and lauch the loop. queue.put((path, where)) upload(True) while not queue.empty(): upload(rec) ############################################# # cf. http://www.tutorialspoint.com/python/python_command_line_arguments.htm def main(argv): command = '' try: opts, args = getopt.getopt(argv, 'hc:') except getopt.GetoptError: help(2) for opt, arg in opts: if opt == '-h': help(0) elif opt in ("-c"): command = arg if command == 'unseen' or command == 'allto' or command == 'getone' or command == 'import': run(command) if __name__ == "__main__": if not sys.argv[1:]: print('Please enter a command.\n Accepted commands are: import, test') else: command, *argv = sys.argv[1:] if command == 'import': upload(argv) elif command == 'test': test(argv) else: print('Unknown command "{}".\n Accepted commands are: import, test'.format(command)) ================================================ FILE: scripts/python/test.py ================================================ #! /usr/bin/env python3.4 # Author: Henri Chataing import unittest from webmail import WebmailApi, ApiError from utils import srandom class ApiTest(unittest.TestCase): @classmethod def setUpClass(self): self._api = WebmailApi() def test_folder(self): foldername = srandom(10) folder = self._api.folder_create(foldername) folderid = folder['id'] self.assertEqual(foldername, folder['name']) # Can not create two folders with same name. self.assertRaises(ApiError, self._api.folder_create, foldername) # Folder get should return same folder. folderget = self._api.folder_get(folderid) self.assertEqual(folderid, folderget['id']) self.assertEqual(foldername, folderget['name']) # Deletion should succeed. self.assertEqual(self._api.folder_delete(folderid), {}) # Second deletion should fail. self.assertRaises(ApiError, self._api.folder_delete, folderid) # TODO: history not included. def test_team(self): teamname = srandom(10) teamkey = self._api.team_insert(teamname) # Can not create two teams with same name. self.assertRaises(ApiError, self._api.team_insert, teamname) # Team get should return same team. teamget = self._api.team_get(teamkey) self.assertEqual(teamname, teamget['name']) self.assertEqual(teamkey, teamget['key']) # Renaming the team should succeed. self._api.team_update(teamkey, teamname+'-upd', 'update') teamget = self._api.team_get(teamkey) self.assertEqual(teamname+'-upd', teamget['name']) self.assertEqual('update', teamget['description']) # The team should be in the returned list. teamlist = self._api.team_list() self.assertTrue(teamkey in teamlist) # Deletion should succeed. self.assertEqual(self._api.team_delete(teamkey), {}) # Later access should fail. self.assertRaises(ApiError, self._api.team_get, teamkey) # Second deletion should fail. self.assertRaises(ApiError, self._api.team_delete, teamkey) # TODO: history not included. def test_user(self): username = srandom(10) user = self._api.user_insert('Alpha', 'Beta', username, 'password') userkey = user['key'] self.assertEqual(user['first_name'], 'Alpha') self.assertEqual(user['last_name'], 'Beta') self.assertEqual(user['username'], username) # Can not create two users with same name. self.assertRaises(ApiError, self._api.user_insert, 'A', 'B', username, 'password') # Test structure of return value, for differing formats. full = self._api.user_get(userkey, format='full') minimal = self._api.user_get(userkey, format='minimal') for field in ['status', 'creator', 'created', 'edited', 'teams', 'level', 'picture', 'sgn', 'blocked', 'salt']: self.assertIn(field, full) self.assertNotIn(field, minimal) for field in ['key', 'username', 'first_name', 'last_name', 'email']: self.assertIn(field, full) self.assertIn(field, minimal) # Check some values. self.assertEqual(full['username'], username) self.assertEqual(full['email']['address']['local'], username) # Update the user and check. self._api.user_update(userkey, 'AA BB', 10, status='admin') full = self._api.user_get(userkey) self.assertEqual(full['level'], 10) self.assertEqual(full['status'], {'admin': {}}) # Update the teams and check. team0 = self._api.team_insert(srandom(10)) team1 = self._api.team_insert(srandom(10)) self._api.user_move(userkey, added_teams=[team0, team1], removed_teams=[]) full = self._api.user_get(userkey) self.assertEqual(full['teams'].sort(), [team0, team1].sort()) self._api.user_move(userkey, added_teams=[team0], removed_teams=[team1]) full = self._api.user_get(userkey) self.assertEqual(full['teams'], [team0]) self._api.user_move(userkey, added_teams=[team0, team1], removed_teams=[]) full = self._api.user_get(userkey) self.assertEqual(full['teams'].sort(), [team0, team1].sort()) self._api.team_delete(team0) self._api.team_delete(team1) # Deletion should succeed. self.assertEqual(self._api.user_delete(userkey), {}) # Later access should fail. self.assertRaises(ApiError, self._api.user_get, userkey) # Second deletion should fail. self.assertRaises(ApiError, self._api.user_delete, userkey) # Launch the tests. if __name__ == "__main__": unittest.main() ================================================ FILE: scripts/python/utils.py ================================================ #! /usr/bin/env python3.4 # Author: Henri Chataing import time, random, string # Import script configuration. try: import config except: config = None # Time a function execution. def timed(fun, *args, **kwargs): start = time.process_time() result = fun(*args, **kwargs) elapsed = time.process_time() - start return result, elapsed # Access configuration variables. def varconfig(name, prompt, printval=True): try: var = eval('config.{}'.format(name)) if printval: print('{}{}'.format(prompt, var)) return var except: return input(prompt) # Return a random string. def srandom(length): try: return ''.join(random.choice(string.ascii_lowercase + string.digits) for _ in range(length)) except: return '[random:{}]'.format(length) ================================================ FILE: scripts/python/webmail.py ================================================ #! /usr/bin/env python3.4 # Author: Henri Chataing import getpass, time import ctypes # from OpenSSL import SSL import webbrowser, requests, json from rauth import OAuth1Service, OAuth1Session from flask import Flask, request, g from multiprocessing import Process, Array, Manager from utils import varconfig ########### SERVER CONFIGURATION ############ # Path to the server certificate. verify = '../../data/server.crt' # Verifier callback. oauth_callback = 'http://localhost:5000/callback' # Token verifier ! manager = Manager() oauth_verifier = manager.Value(ctypes.c_char_p, '') # Server configuration. Necessary to receive the verifier. def run_server(oauth_verifier): app = Flask(__name__) @app.route('/callback') def callback(): verifier = request.args.get('oauth_verifier') if verifier: oauth_verifier.value = verifier return 'Acquired verifier' app.run() # Server object. server = None # Create new server if necessary, and start it. def start_server(): global server if server is None: oauth_verifier.value = '' server = Process(target=run_server, args=(oauth_verifier,)) server.start() # Terminate server and join. def terminate_server(): global server if not server is None: server.terminate() server.join() server = None ################ REST API ################### # Internal Errors. class ApiError(Exception): def __init__(self, code, method, error=None): self.code = code self.error = error self.method = method def __repr__(self): return 'ApiError({}, {}, {})'.format(self.code, self.method, repr(self.error)) def __str__(self): return '{} <{}>: {}'.format(self.method, self.code, repr(self.error)) class WebmailApi: session = None # Precomputed API urls. _base_url = '' _upload_url = '' # The class "constructor" - It's actually an initializer def __init__(self, host='localhost', port='4443'): if port == '443' or port == '': self._base_url = 'https://{}/api/v0'.format(host, port) self._upload_url = 'https://{}/upload/api/v0'.format(host, port) else: self._base_url = 'https://{}:{}/api/v0'.format(host, port) self._upload_url = 'https://{}:{}/upload/api/v0'.format(host, port) consumer_key = varconfig('consumer_key', 'OAuth Consumer key: ', printval=False) consumer_secret = varconfig('consumer_secret', 'OAuth Consumer secret: ', printval=False) # Consumer key is undefined, switching to regular login. if consumer_key == '': username = input('PEPS Login: ') password = getpass.getpass('Password: ') data = {'username': username, 'password': password} headers = {'content-type': 'application/json'} res = requests.post('{}/login'.format(self._base_url), data=json.dumps(data), headers=headers, verify=verify) try: token = res.json()['token'] self.session = OAuth1Session('', '', access_token=token, access_token_secret='') print('Api has been successfully configured') except Exception as err: print('Api: Configuration error: {}'.format(err)) self.session = None # Consumer key has been provided, standard OAuth flow. else: peps = OAuth1Service( name='webmail-api-test', consumer_key=consumer_key, consumer_secret=consumer_secret, request_token_url='{}/oauth/request_token'.format(self._base_url), access_token_url='{}/oauth/access_token'.format(self._base_url), authorize_url='{}/oauth/authorize'.format(self._base_url), base_url=self._base_url ) print("---> Initiate OAuth1 connection") request_token, request_token_secret = peps.get_request_token(verify=verify, params={'oauth_callback': oauth_callback}) print("---> Request token") authorize_url = peps.get_authorize_url(request_token, verify=verify, params={'oauth_callback': oauth_callback}) print("---> Authorize token") print('Visit this URL in your browser: {url}'.format(url=authorize_url)) webbrowser.open(authorize_url) # Authenticate the user. start_server() # Open the server to receive the verifier. # oauth_verifier = input('Enter oauth_verifier from browser: ') # Waiting for the token verifier... tries = 0 while oauth_verifier.value == '' and tries < 30: time.sleep(1) tries = tries + 1 terminate_server() if oauth_verifier.value == '': print('I waited too long for your password, now I am leaving...') else: print("---> Create session") self.session = peps.get_auth_session( request_token, request_token_secret, method='POST', verify=verify, params={'oauth_verifier': oauth_verifier.value}, headers={'content-type': 'application/json'}, # These two things are necessary to data='{}' # prevent rauth from using the body to pass the oauth tokens. ) print('Api has been successfully configured !') # Intercept JSON parsing errors, as well as error status codes. def _extract(self, result, method): try: data = result.json() if result.status_code == 200: return data elif 'error' in data: raise ApiError(result.status_code, method, error=data['error']) else: raise ApiError(result.status_code, method) except ValueError: raise ApiError(result.status_code, method, error='Malformed response') ### Folders. ### # List folders. def folder_list(self): result = self.session.get('{}/users/me/folders'.format(self._base_url), verify=verify) return self._extract(result, 'folder.list') # Get single folder. def folder_get(self, id): result = self.session.get('{}/users/me/folders/{}'.format(self._base_url, id), verify=verify) return self._extract(result, 'folder.get') # Delete a folder. def folder_delete(self, id): result = self.session.delete('{}/users/me/folders/{}'.format(self._base_url, id), verify=verify) return self._extract(result, 'folder.delete') def folder_create(self, name): data = json.dumps({'name': name}) result = self.session.post('{}/users/me/folders'.format(self._base_url), verify=verify, headers={'content-type': 'application/json'}, data=data) return self._extract(result, 'folder.create') def folder_update(self, id, newname): data = json.dumps({'name': newname}) result = self.session.put('{}/users/me/folders/{}'.format(self._base_url, id), verify=verify, headers={'content-type': 'application/json'}, data=data) return self._extract(result, 'folder.update') ### Tags. ### # List folders. def tag_list(self): result = self.session.get('{}/users/me/tags'.format(self._base_url), verify=verify) return self._extract(result, 'tag.list') # Get single folder. def tag_get(self, id): result = self.session.get('{}/users/me/tags/{}'.format(self._base_url, id), verify=verify) return self._extract(result, 'tag.get') # Delete a folder. def tag_delete(self, id): result = self.session.delete('{}/users/me/tags/{}'.format(self._base_url, id), verify=verify) return self._extract(result, 'tag.delete') def tag_create(self, data): data = json.dumps(data) result = self.session.post('{}/users/me/tags'.format(self._base_url), verify=verify, headers={'content-type': 'application/json'}, data=data) return self._extract(result, 'tag.create') def tag_update(self, id, data): data = json.dumps(data) result = self.session.put('{}/users/me/tags/{}'.format(self._base_url, id), verify=verify, headers={'content-type': 'application/json'}, data=data) return self._extract(result, 'tag.update') ### Messages. ### def message_trash(self, id): result = self.session.post('{}/users/me/messages/{}/trash'.format(self._base_url, id), verify=verify, headers={'content-type': 'text/plain'}, data='') return self._extract(result, 'message.trash') def message_untrash(self, id): result = self.session.post('{}/users/me/messages/{}/untrash'.format(self._base_url, id), verify=verify, headers={'content-type': 'text/plain'}, data='') return self._extract(result, 'message.untrash') def message_delete(self, id): result = self.session.delete('{}/users/me/messages/{}'.format(self._base_url, id), verify=verify, headers={'content-type': 'text/plain'}, data='') return self._extract(result, 'message.delete') def message_get(self, id): result = self.session.get('{}/users/me/messages/{}'.format(self._base_url, id), verify=verify, headers={'content-type': 'text/plain'}, data='') return self._extract(result, 'message.get') def message_list(self, maxResults=None, pageToken=None, labelId='INBOX'): params = {'labelIds': labelId} if not maxResults is None: params['maxResults'] = maxResults if not pageToken is None: params['pageToken'] = pageToken result = self.session.get('{}/users/me/messages'.format(self._base_url), verify=verify, headers={'content-type': 'text/plain'}, params=params) return self._extract(result, 'message.list') def message_modify(self, id, change): data = json.dumps(change) result = self.session.post('{}/users/me/messages/{}/modify'.format(self._base_url, id), verify=verify, headers={'content-type': 'application/json'}, data=data) return self._extract(result, 'message.modify') def message_insert(self, upload_type, data, cte): ct = 'text/plain' if upload_type == 'media': ct = 'message/rfc822' elif upload_type == 'multipart': ct = 'application/json' else: print('Unrecognized upload type') return None result = self.session.post( '{}/users/me/messages'.format(self._upload_url), verify=verify, headers={'content-type': ct, 'content-transfer-encoding': cte}, params={'uploadType': upload_type}, data=data) return self._extract(result, 'message.insert') def message_attachment(self, id, attachment): result = self.session.get('{}/users/me/messages/{}/attachments/{}'.format(self._base_url, id, attachment), verify=verify, headers={'content-type': 'text/plain'}, data='') return self._extract(result, 'message.attachment') ### History. ### def message_history(self, startHistoryId, labelId=None, pageToken=None, maxResults=None): params = {'startHistoryId': startHistoryId} if labelId: params['labelId'] = labelId if pageToken: params['pageToken'] = pageToken if maxResults: params['maxResults'] = maxResults result = self.session.get('{}/users/me/history'.format(self._base_url), verify=verify, headers={'content-type': 'text/plain'}, params=params) return self._extract(result, 'message.history') ### Drafts. ### # def draft_insert(self): # result = self.session.post('{}/users/me/drafts'.format(self._base_url), verify=verify, headers={'content-type': 'text/plain'}) # return result.json() def draft_delete(self, id): result = self.session.delete('{}/users/me/drafts/{}'.format(self._base_url, id), verify=verify, headers={'content-type': 'text/plain'}) return self._extract(result, 'draft.delete') def draft_get(self, id): result = self.session.get('{}/users/me/drafts/{}'.format(self._base_url, id), verify=verify, headers={'content-type': 'text/plain'}) return self._extract(result, 'draft.get') # def draft_list(self) # result = self.session.get('{}/users/me/drafts/'.format(self._base_url), verify=verify, headers={'content-type': 'text/plain'}) # return result.json() # def draft_update(self, id) # result = self.session.put('{}/users/me/drafts/'.format(self._base_url), verify=verify, headers={'content-type': 'text/plain'}) # return result.json() def draft_send(self, id): data = json.dumps({'id': id}) result = self.session.post('{}/users/me/drafts/send'.format(self._base_url), verify=verify, headers={'content-type': 'application/json'}, data=data) return self._extract(result, 'message.send') ### Users. ### def user_get(self, key, format='full'): result = self.session.get('{}/users/{}'.format(self._base_url, key), verify=verify, headers={'content-type': 'text/plain'}, data='', params={'format': format}) return self._extract(result, 'user.get') def user_update(self, key, fullname, level, status='lambda'): data = json.dumps({'fullname': fullname, 'level': level, 'status': status}) result = self.session.put('{}/users/{}'.format(self._base_url, key), verify=verify, headers={'content-type': 'application/json'}, data=data) return self._extract(result, 'user.update') def user_move(self, key, added_teams=[], removed_teams=[]): data = json.dumps({'addedTeamKeys': added_teams, 'removedTeamKeys': removed_teams}) result = self.session.put('{}/users/{}/move'.format(self._base_url, key), verify=verify, headers={'content-type': 'application/json'}, data=data) return self._extract(result, 'user.move') def user_delete(self, key): result = self.session.delete('{}/users/{}'.format(self._base_url, key), verify=verify, headers={'content-type': 'text/plain'}, data='') return self._extract(result, 'user.delete') def user_insert(self, firstName, lastName, username, password, level=1, teams=[]): data = json.dumps({ 'firstName': firstName, 'lastName': lastName, 'username': username, 'password': password, 'level': level, 'teams': teams }) result = self.session.post('{}/users'.format(self._base_url), verify=verify, headers={'content-type': 'application/json'}, data=data) return self._extract(result, 'user.insert') # Fixme: teamKeys can only take one argument at present, else signature is wrong. def user_list(self, maxResults=None, pageToken=None, teamKeys=None): # Request takes care of None-valued parameters, as well as value lists. params = {} if not maxResults is None: params['maxResults'] = maxResults if not pageToken is None: params['pageToken'] = pageToken if not teamKeys is None: params['teamKeys'] = teamKeys result = self.session.get('{}/users'.format(self._base_url), verify=verify, headers={'content-type': 'text/plain'}, data='', params=params) return self._extract(result, 'user.list') def user_history(self, startHistoryId, maxResults=None): params = {'startHistoryId': startHistoryId, 'maxResults': maxResults} # if maxResults: # params['maxResults'] = maxResults result = self.session.get('{}/users/history'.format(self._base_url), verify=verify, headers={'content-type': 'text/plain'}, params=params) return self._extract(result, 'user.history') ### Teams. ### def team_get(self, key): result = self.session.get('{}/teams/{}'.format(self._base_url, key), verify=verify, headers={'content-type': 'text/plain'}) return self._extract(result, 'user.get') def team_insert(self, name, parent=None, description=''): data = {'name': name, 'description': description, 'parent': parent} if parent is None: data['parent'] = {'none': {}} else: data['parent'] = {'some': parent} data = json.dumps(data) result = self.session.post('{}/teams'.format(self._base_url), verify=verify, headers={'content-type': 'application/json'}, data=data) return self._extract(result, 'team.insert') def team_update(self, key, name, description): data = json.dumps({'name': name, 'description': description}) result = self.session.put('{}/teams/{}'.format(self._base_url, key), verify=verify, headers={'content-type': 'application/json'}, data=data) return self._extract(result, 'team.update') def team_delete(self, key): result = self.session.delete('{}/teams/{}'.format(self._base_url, key), verify=verify, headers={'content-type': 'text/plain'}) return self._extract(result, 'team.delete') def team_list(self): result = self.session.get('{}/teams'.format(self._base_url), verify=verify) return self._extract(result, 'team.list') def team_history(self, startHistoryId, maxResults=None): params = {'startHistoryId': startHistoryId} if maxResults: params['maxResults'] = maxResults result = self.session.get('{}/teams/history'.format(self._base_url), verify=verify, headers={'content-type': 'text/plain'}, params=params) return self._extract(result, 'team.history') ### Files ### def file_get(self, path): result = self.session.get('{}/files/{}'.format(self._upload_url, path), verify=verify, headers={'content-type': 'text/plain'}) return self._extract(result, 'file.get') def file_metadata(self, path, list=False, file_limit=10000): params = {'list': list, 'file_limit': file_limit} result = self.session.get('{}/files/metadata/{}'.format(self._base_url, path), verify=verify, headers={'content-type': 'text/plain'}, data='', params=params) return self._extract(result, 'file.metadata') def file_upload(self, path, data, mimetype, cte): # params = {'list': list, 'file_limit': file_limit} headers = { 'content-type': mimetype, 'content-transfer-encoding': cte } result = self.session.post('{}/files_put/{}'.format(self._upload_url, path), verify=verify, headers=headers, data=data) return self._extract(result, 'file.upload') def file_move(self, from_path, to_path, root=''): headers = {'content-type': 'text/plain'} params = {'from_path': from_path, 'to_path': to_path, 'root': root} result = self.session.post('{}/fileops/move'.format(self._base_url), verify=verify, headers=headers, params=params) return self._extract(result, 'file.move') def file_copy(self, from_path, to_path, root=''): headers = {'content-type': 'text/plain'} params = {'from_path': from_path, 'to_path': to_path, 'root': root} result = self.session.post('{}/fileops/copy'.format(self._base_url), verify=verify, headers=headers, params=params) return self._extract(result, 'file.copy') def file_delete(self, path): headers = {'content-type': 'text/plain'} params = {'path': path} result = self.session.post('{}/fileops/delete'.format(self._base_url), verify=verify, headers=headers, params=params) return self._extract(result, 'file.delete') ================================================ FILE: smtpin/Dockerfile ================================================ FROM node:6 # Install Haraka RUN npm install -g Haraka RUN haraka -i /usr/local/haraka # Copy package.json for plugin dependencies COPY ./package.json /usr/local/haraka # Install plugin dependencies WORKDIR /usr/local/haraka RUN npm install # Configure domain COPY ./domain /usr/local/haraka/config/host_list # Configurations COPY ./config /usr/local/haraka/config # Plugins COPY ./plugins /usr/local/haraka/plugins # Mount /etc/peps for TLS certificates VOLUME ["/etc/peps"] # Copy start script COPY ./haraka.sh / EXPOSE 25 # TODO: key + dual port # EXPOSE 587 # Start haraka CMD ["bash", "/haraka.sh"] ================================================ FILE: smtpin/config/databytes ================================================ 20000000 ================================================ FILE: smtpin/config/loglevel ================================================ LOGWARN ================================================ FILE: smtpin/config/plugins ================================================ # log.syslog # control which IPs, rDNS hostnames, HELO hostnames, MAIL FROM addresses, and # RCPT TO address you accept mail from. See 'haraka -h access'. access # block mails from known bad hosts (see config/dnsbl.zones for the DNS zones queried) dnsbl # Check mail headers are valid data.headers # block mail from some known bad HELOs - see config/helo.checks.ini for configuration helo.checks # see 'haraka -h tls' for config instructions before enabling! # tls # Only accept mail where the MAIL FROM domain is resolvable to an MX record # mail_from.is_resolvable # Disconnect client if they spew bad SMTP commands at us max_unrecognized_commands # Only accept mail for your personal list of hosts. Edit config/host_list # NOTE: THIS IS REQUIRED for inbound email. rcpt_to.in_host_list # Enable TLS tls # PEPS SMTP in plugin smtpin # Queue inbound messages test_queue ================================================ FILE: smtpin/config/smtp.ini ================================================ port = 25 ================================================ FILE: smtpin/config/smtpin.ini ================================================ host = peps:8999 ================================================ FILE: smtpin/haraka.sh ================================================ #!/bin/sh # TLS Settings. cp /etc/peps/server.key /usr/local/haraka/config/tls_key.pem cp /etc/peps/server.crt /usr/local/haraka/config/tls_cert.pem # Sleep to wait for PEPS to be ready sleep 30 exec haraka -c /usr/local/haraka ================================================ FILE: smtpin/package.json ================================================ { "name": "haraka_smtpin", "version": "1.0.0", "description": "PEPS SMTP inbound", "dependencies": { "request": "^2.75.0" } } ================================================ FILE: smtpin/plugins/smtpin.js ================================================ // SMTP in plugin for PEPS // Copyright (c) MLstate, 2015 // // Contains code from https://github.com/jplock/haraka-http-forward // Copyright (c) 2013 Justin Plock // Permission is hereby granted, free of charge, to any person obtaining a copy // of this software and associated documentation files (the "Software"), to deal // in the Software without restriction, including without limitation the rights // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell // copies of the Software, and to permit persons to whom the Software is // furnished to do so, subject to the following conditions: // The above copyright notice and this permission notice shall be included in // all copies or substantial portions of the Software. // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN // THE SOFTWARE. var request = require('request'); var stream = require('stream'); // While debugging uncomment this and put "LOGDEBUG" in the file "loglevel" // request.debug = true; var host, domain; exports.register = function() { this.loginfo("In register"); var config = this.config.get('/usr/local/haraka/config/smtpin.ini'); if (config.main.host) { // check validity var match = /^([^: ]+)(?::(\d+))?$/.exec(config.main.host); if (match) { host = config.main.host; //peps:8999 request('http://' + host + '/domain', function(error, response, body) { if (!error && response.statusCode == 200) { domain = body; } else { throw new Error('could not get domain from ' + host); } } ); } else { throw new Error('could not parse host value: ' + config.main.host); } } else { throw new Error('configuration file missing'); } }; exports.hook_data_post = function(next, connection) { // For logging inside functions var self = this; var transaction = connection.transaction; // TODO: check that recipients (transaction.rcpt_to) matches domain name? // transaction.message_stream is not a ReadableStream but a MessageStream // so request doesn't read from it directly. It's needed to put a passThrough // stream to be written by the message stream and read by request var passThrough = new stream.PassThrough(); // Give the passThrough stream to the message stream transaction.message_stream.pipe(passThrough); // Options for request including the passThrough stream that will contain // the message (with message headers as "To:" and "From:" included) var options = { 'uri': 'http://' + host, 'headers': { 'Content-Type': 'text/plain; charset=utf-8' }, 'method': 'post', 'timeout': 1000, 'pool': false, 'jar': false, 'body': passThrough }; // Send the post request to PEPS and continue the Haraka flow using next() request.post(options, function(error, response, body) { if (error) { self.logerror('request error:' + JSON.stringify(error)); connection.logerror('unable to connect to ' + host + ' (' + error + ')'); } else { self.loginfo('request with email sent'); } return next(); }); }; ================================================ FILE: smtpout/Dockerfile ================================================ FROM node:6 # Install Haraka RUN npm install -g Haraka RUN haraka -i /usr/local/haraka # Copy package.json for plugin dependencies COPY ./package.json /usr/local/haraka # Install plugin dependencies WORKDIR /usr/local/haraka RUN npm install # Configure domain COPY ./domain /usr/local/haraka/config/host_list # Configurations COPY ./config /usr/local/haraka/config # Plugins COPY ./plugins /usr/local/haraka/plugins # Mount /etc/peps for TLS certificates VOLUME ["/etc/peps"] # Copy start script COPY ./haraka.sh / EXPOSE 25 # TODO: key + dual port # EXPOSE 587 # Start haraka CMD ["bash", "/haraka.sh"] ================================================ FILE: smtpout/config/databytes ================================================ 20000000 ================================================ FILE: smtpout/config/loglevel ================================================ LOGWARN ================================================ FILE: smtpout/config/plugins ================================================ # log.syslog # control which IPs, rDNS hostnames, HELO hostnames, MAIL FROM addresses, and # RCPT TO address you accept mail from. See 'haraka -h access'. # access # block mails from known bad hosts (see config/dnsbl.zones for the DNS zones queried) # dnsbl # Relay messages smtpout # Check mail headers are valid data.headers # block mail from some known bad HELOs - see config/helo.checks.ini for configuration # helo.checks # Disconnect client if they spew bad SMTP commands at us max_unrecognized_commands ================================================ FILE: smtpout/config/smtp.ini ================================================ port = 25 ================================================ FILE: smtpout/haraka.sh ================================================ #!/bin/sh # TLS Settings. cp /etc/peps/server.key /usr/local/haraka/config/tls_key.pem cp /etc/peps/server.crt /usr/local/haraka/config/tls_cert.pem # Sleep to wait for PEPS to be ready sleep 30 exec haraka -c /usr/local/haraka ================================================ FILE: smtpout/package.json ================================================ { "name": "haraka_smtpout", "version": "1.0.0", "description": "PEPS SMTP outbound", "dependencies": { } } ================================================ FILE: smtpout/plugins/smtpout.js ================================================ // SMTP out plugin for PEPS // Copyright (c) MLstate, 2015 exports.hook_mail = function (next, connection, params) { connection.relaying = true; next(); } ================================================ FILE: solr/Dockerfile ================================================ # Solr container # This version is a temporary fix as the upstream container definition has been ugraded to Solr 5 # This container does not use baseimage yet FROM makuk66/docker-oracle-java7 MAINTAINER MLstate ENV SOLR_VERSION 4.10.4 ENV SOLR solr-$SOLR_VERSION RUN export DEBIAN_FRONTEND=noninteractive && \ apt-get update && \ apt-get -y install lsof curl procps && \ mkdir -p /opt && \ wget -nv --output-document=/opt/$SOLR.tgz http://archive.apache.org/dist/lucene/solr/$SOLR_VERSION/$SOLR.tgz && \ tar -C /opt --extract --file /opt/$SOLR.tgz && \ rm /opt/$SOLR.tgz && \ ln -s /opt/$SOLR /opt/solr # Install stuff we need RUN apt-get update && apt-get install -y \ curl \ unzip # Download the solr config information RUN curl -sf -o /tmp/solr.zip -L https://github.com/MLstate/PEPS/releases/download/0.9.9/solr.zip RUN mkdir -p /solr && cd /solr && unzip -q /tmp/solr.zip RUN rm /tmp/solr.zip # The solr installation directories. ENV SOLR_ROOT /opt/solr ENV SOLR_DATA $SOLR_ROOT/example/solr # Install the four cores; mail, file, user and contact. # We need to install the schema file plus a link from the # solr data directory to the externally mounted data directory. RUN cp -r $SOLR_DATA/collection1 $SOLR_DATA/peps_mail RUN echo "name=peps_mail" > $SOLR_DATA/peps_mail/core.properties RUN cp /solr/conf/solr_schema_mail.xml $SOLR_DATA/peps_mail/conf/schema.xml RUN ln -s /solr_data/peps_mail $SOLR_DATA/peps_mail/data RUN cp -r $SOLR_DATA/collection1 $SOLR_DATA/peps_file RUN echo "name=peps_file" > $SOLR_DATA/peps_file/core.properties RUN cp /solr/conf/solr_schema_file.xml $SOLR_DATA/peps_file/conf/schema.xml RUN ln -s /solr_data/peps_file $SOLR_DATA/peps_file/data RUN cp -r $SOLR_DATA/collection1 $SOLR_DATA/peps_user RUN echo "name=peps_user" > $SOLR_DATA/peps_user/core.properties RUN cp /solr/conf/solr_schema_user.xml $SOLR_DATA/peps_user/conf/schema.xml RUN ln -s /solr_data/peps_user $SOLR_DATA/peps_user/data RUN cp -r $SOLR_DATA/collection1 $SOLR_DATA/peps_contact RUN echo "name=peps_contact" > $SOLR_DATA/peps_contact/core.properties RUN cp /solr/conf/solr_schema_contact.xml $SOLR_DATA/peps_contact/conf/schema.xml RUN ln -s /solr_data/peps_contact $SOLR_DATA/peps_contact/data # Run the Solr server. EXPOSE 8983 CMD ["/bin/bash","-c","cd /opt/solr/example; java -Djetty.port=8983 -jar start.jar"]