Merge pull request #98 from IanLee1521/dockerfile

Dockerfile

Dockerfile

@@ -0,0 +1,14 @@
+FROM python:3
+
+WORKDIR /app
+
+COPY requirements.txt requirements.txt
+
+RUN pip install --no-cache-dir -r requirements.txt
+
+COPY . .
+
+RUN pip install --editable .
+
+ENTRYPOINT ["trustymail"]
+CMD ["--help"]

README.md

@@ -42,6 +42,14 @@ Then run the CLI:
 python scripts/trustymail [options] example.com
 ```
 
+### Using Docker (optional)
+
+```bash
+./run [opts]
+```
+
+`opts` are the same arguments that would get passed to `trustymail`.
+
 ### Usage and examples ###
 
 ```bash
@@ -61,38 +69,38 @@ output will always be written to disk, defaulting to `results.csv`.
   -h --help                   Show this message.
   -o --output=OUTFILE         Name of output file. (Default results)
   -t --timeout=TIMEOUT        The DNS lookup timeout in seconds. (Default is 5.)
-  --smtp-timeout=TIMEOUT      The SMTP connection timeout in seconds. (Default 
+  --smtp-timeout=TIMEOUT      The SMTP connection timeout in seconds. (Default
                               is 5.)
-  --smtp-localhost=HOSTNAME   The hostname to use when connecting to SMTP 
+  --smtp-localhost=HOSTNAME   The hostname to use when connecting to SMTP
                               servers.  (Default is the FQDN of the host from
                               which trustymail is being run.)
-  --smtp-ports=PORTS          A comma-delimited list of ports at which to look 
+  --smtp-ports=PORTS          A comma-delimited list of ports at which to look
                               for SMTP servers.  (Default is '25,465,587'.)
-  --no-smtp-cache             Do not cache SMTP results during the run.  This 
-                              may results in slower scans due to testing the 
+  --no-smtp-cache             Do not cache SMTP results during the run.  This
+                              may results in slower scans due to testing the
                               same mail servers multiple times.
   --mx                        Only check mx records
-  --starttls                  Only check mx records and STARTTLS support. 
+  --starttls                  Only check mx records and STARTTLS support.
                               (Implies --mx.)
   --spf                       Only check spf records
   --dmarc                     Only check dmarc records
   --debug                     Output should include error messages.
-  --dns=HOSTNAMES             A comma-delimited list of DNS servers to query 
-                              against.  For example, if you want to use 
-                              Google's DNS then you would use the 
-                              value --dns-hostnames='8.8.8.8,8.8.4.4'.  By 
-                              default the DNS configuration of the host OS 
-                              (/etc/resolv.conf) is used.  Note that 
-                              the host's DNS configuration is not used at all 
+  --dns=HOSTNAMES             A comma-delimited list of DNS servers to query
+                              against.  For example, if you want to use
+                              Google's DNS then you would use the
+                              value --dns-hostnames='8.8.8.8,8.8.4.4'.  By
+                              default the DNS configuration of the host OS
+                              (/etc/resolv.conf) is used.  Note that
+                              the host's DNS configuration is not used at all
                               if this option is used.
   --psl-filename=FILENAME     The name of the file where the public suffix list
                               (PSL) cache will be saved.  If set to the name of
                               an existing file then that file will be used as
                               the PSL.  If not present then the PSL cache will
                               be saved to a file in the current directory called
                               public_suffix_list.dat.
-  --psl-read-only             If present, then the public suffix list (PSL) 
-                              cache will be read but never overwritten.  This 
+  --psl-read-only             If present, then the public suffix list (PSL)
+                              cache will be read but never overwritten.  This
                               is useful when running in AWS Lambda, for
                               instance, where the local filesystem is read-only.
 ```
@@ -160,7 +168,7 @@ The following values are returned in `results.csv`:
 * `DMARC Aggregate Report URIs` - A list of the DMARC aggregate report
   URIs specified by the domain.
 * `DMARC Forensic Report URIs` - A list of the DMARC forensic report
-  URIs specified by the domain. 
+  URIs specified by the domain.
 * `DMARC Has Aggregate Report URI` - A boolean value that indicates if
   `DMARC Results` included `rua` URIs that tell recipients where to
   send DMARC aggregate reports.

requirements-dev.txt

@@ -0,0 +1,7 @@
+-r requirements.txt
+
+check-manifest>=0.36
+pytest>=3.5.0
+semver>=2.7.9
+tox>=3.0.0
+wheel>=0.31.0

requirements.txt

@@ -1 +1,6 @@
--e .[dev]
+dnspython>=1.15.0
+docopt>=0.6.2
+publicsuffix>=1.1.0
+py3dns>=3.1.0
+pyspf==2.0.11
+requests>=2.18.4

run

@@ -0,0 +1,11 @@
+#!/bin/bash
+
+set -e
+set -x
+
+docker build -t trustymail/cli .
+
+docker run --rm -it \
+  --name trustymail \
+  -v $(pwd):/app \
+  trustymail/cli $@

setup.py

@@ -15,6 +15,14 @@ def readme():
         return f.read()
 
 
+with open('requirements.txt') as fp:
+    reqs = [line.strip() for line in fp.readlines() if line]
+
+with open('requirements-dev.txt') as fp:
+    lines = [line.strip() for line in fp.readlines() if line]
+    dev_reqs = [line for line in lines if line and '-r requirements.txt' not in line]
+
+
 setup(
     name='trustymail',
     version=__version__,
@@ -61,23 +69,10 @@ def readme():
 
     packages=['trustymail'],
 
-    install_requires=[
-        'dnspython>=1.15.0',
-        'docopt>=0.6.2',
-        'publicsuffix>=1.1.0',
-        'py3dns>=3.1.0',
-        'pyspf==2.0.11',
-        'requests>=2.18.4'
-    ],
+    install_requires=reqs,
 
     extras_require={
-        'dev': [
-            'check-manifest>=0.36',
-            'pytest>=3.5.0',
-            'semver>=2.7.9',
-            'tox>=3.0.0',
-            'wheel>=0.31.0'
-        ],
+        'dev': dev_reqs,
     },
 
     scripts=['scripts/trustymail']

trustymail/__init__.py

@@ -1,6 +1,6 @@
 from __future__ import unicode_literals, absolute_import, print_function
 
-__version__ = '0.6.4'
+__version__ = '0.6.5-dev'
 
 PublicSuffixListFilename = 'public_suffix_list.dat'
 PublicSuffixListReadOnly = False