New upstream version 18.1.0

8 files changed, 137 insertions, 115 deletions

diff --git a/docs/api.rst b/docs/api.rst
index f80ea7f..91b1c23 100644
--- a/docs/api.rst
+++ b/docs/api.rst
@@ -4,16 +4,17 @@ API
 
 .. note::
 
-   The APIs for RFC 6125 verification beyond DNS-IDs (i.e. hostnames) aren't public yet.
-   They are in place and used by the documented high-level APIs though.
-   Eventually they will become public.
+   So far, public APIs are only available for hostnames (RFC 6125) and IP addresses (RFC 2818).
+   All IDs specified by RFC 6125 are already implemented though.
    If you'd like to play with them and provide feedback have a look at the ``verify_service_identity`` function in the `_common module <https://github.com/pyca/service_identity/blob/master/src/service_identity/_common.py>`_.
 
 
-.. currentmodule:: service_identity.pyopenssl
+pyOpenSSL
+=========
 
+.. currentmodule:: service_identity.pyopenssl
 
-.. autofunction:: verify_hostname(connection, hostname)
+.. autofunction:: verify_hostname
 
    In practice, this may look like the following::
 
@@ -46,11 +47,23 @@ API
          conn.shutdown()
          conn.close()
 
+.. autofunction:: verify_ip_address
+
+
+PyCA cryptography
+=================
+
+.. currentmodule:: service_identity.cryptography
+
+.. autofunction:: verify_certificate_hostname
+.. autofunction:: verify_certificate_ip_address
+
+
+Universal Errors and Warnings
+=============================
 
 .. currentmodule:: service_identity
 
 .. autoexception:: VerificationError
-
 .. autoexception:: CertificateError
-
-.. autoexception:: SubjectAltNameWarning
\ No newline at end of file
+.. autoexception:: SubjectAltNameWarning
diff --git a/docs/changelog.rst b/docs/changelog.rst
index 4d7817a..565b052 100644
--- a/docs/changelog.rst
+++ b/docs/changelog.rst
@@ -1 +1 @@
-.. include:: ../CHANGELOG.rst
\ No newline at end of file
+.. include:: ../CHANGELOG.rst
diff --git a/docs/conf.py b/docs/conf.py
index d9bf349..41f8241 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -17,11 +17,6 @@ import datetime
 import os
 import re
 
-try:
-    import sphinx_rtd_theme
-except ImportError:
-    sphinx_rtd_theme = None
-
 
 def read(*parts):
     """
@@ -39,51 +34,51 @@ def find_version(*file_paths):
     string inside.
     """
     version_file = read(*file_paths)
-    version_match = re.search(r"^__version__ = ['\"]([^'\"]*)['\"]",
-                              version_file, re.M)
+    version_match = re.search(
+        r"^__version__ = ['\"]([^'\"]*)['\"]", version_file, re.M
+    )
     if version_match:
         return version_match.group(1)
     raise RuntimeError("Unable to find version string.")
 
+
 # If extensions (or modules to document with autodoc) are in another directory,
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.
-#sys.path.insert(0, os.path.abspath('.'))
+# sys.path.insert(0, os.path.abspath('.'))
 
 # -- General configuration ------------------------------------------------
 
 # If your documentation needs a minimal Sphinx version, state it here.
-#needs_sphinx = '1.0'
+# needs_sphinx = '1.0'
 
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
 extensions = [
-    'sphinx.ext.doctest',
-    'sphinx.ext.autodoc',
-    'sphinx.ext.intersphinx',
-    'sphinx.ext.todo',
-    'sphinx.ext.coverage',
+    "sphinx.ext.doctest",
+    "sphinx.ext.autodoc",
+    "sphinx.ext.intersphinx",
+    "sphinx.ext.todo",
+    "sphinx.ext.coverage",
 ]
 
 # Add any paths that contain templates here, relative to this directory.
-templates_path = ['_templates']
+templates_path = ["_templates"]
 
 # The suffix of source filenames.
-source_suffix = '.rst'
+source_suffix = ".rst"
 
 # The encoding of source files.
-#source_encoding = 'utf-8-sig'
+# source_encoding = 'utf-8-sig'
 
 # The master toctree document.
-master_doc = 'index'
+master_doc = "index"
 
 # General information about the project.
-project = u'service_identity'
+project = u"service_identity"
 year = datetime.date.today().year
-copyright = u'2014{0}, Hynek Schlawack'.format(
-    u'-{0}'.format(year) if year != 2014 else u""
-)
+copyright = u"2014, Hynek Schlawack"
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
@@ -94,41 +89,41 @@ version = release.rsplit(u".", 1)[0]
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
-#language = None
+# language = None
 
 # There are two options for replacing |today|: either, you set today to some
 # non-false value, then it is used:
-#today = ''
+# today = ''
 # Else, today_fmt is used as the format for a strftime call.
-#today_fmt = '%B %d, %Y'
+# today_fmt = '%B %d, %Y'
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
-exclude_patterns = ['_build']
+exclude_patterns = ["_build"]
 
 # The reST default role (used for this markup: `text`) to use for all
 # documents.
-#default_role = None
+# default_role = None
 
 # If true, '()' will be appended to :func: etc. cross-reference text.
-#add_function_parentheses = True
+# add_function_parentheses = True
 
 # If true, the current module name will be prepended to all description
 # unit titles (such as .. function::).
-#add_module_names = True
+# add_module_names = True
 
 # If true, sectionauthor and moduleauthor directives will be shown in the
 # output. They are ignored by default.
-#show_authors = False
+# show_authors = False
 
 # The name of the Pygments (syntax highlighting) style to use.
-pygments_style = 'sphinx'
+pygments_style = "sphinx"
 
 # A list of ignored prefixes for module index sorting.
-#modindex_common_prefix = []
+# modindex_common_prefix = []
 
 # If true, keep warnings as "system message" paragraphs in the built documents.
-#keep_warnings = False
+# keep_warnings = False
 
 
 # -- Options for HTML output ----------------------------------------------
@@ -136,35 +131,38 @@ pygments_style = 'sphinx'
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 
-if sphinx_rtd_theme:
-    html_theme = "sphinx_rtd_theme"
-    html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
-else:
-    html_theme = "default"
+html_theme = "alabaster"
+html_theme_options = {
+    "font_family": '"Avenir Next", Calibri, "PT Sans", sans-serif',
+    "head_font_family": '"Avenir Next", Calibri, "PT Sans", sans-serif',
+    "font_size": "18px",
+    "page_width": "980px",
+    "show_relbars": True,
+}
 
 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the
 # documentation.
-#html_theme_options = {}
+# html_theme_options = {}
 
 # Add any paths that contain custom themes here, relative to this directory.
-#html_theme_path = []
+# html_theme_path = []
 
 # The name for this set of Sphinx documents.  If None, it defaults to
 # "<project> v<release> documentation".
-#html_title = None
+# html_title = None
 
 # A shorter title for the navigation bar.  Default is the same as html_title.
-#html_short_title = None
+# html_short_title = None
 
 # The name of an image file (relative to this directory) to place at the top
 # of the sidebar.
-#html_logo = None
+# html_logo = None
 
 # The name of an image file (within the static path) to use as favicon of the
 # docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
 # pixels large.
-#html_favicon = None
+# html_favicon = None
 
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
@@ -174,93 +172,89 @@ else:
 # Add any extra paths that contain custom files (such as robots.txt or
 # .htaccess) here, relative to this directory. These files are copied
 # directly to the root of the documentation.
-#html_extra_path = []
+# html_extra_path = []
 
 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
 # using the given strftime format.
-#html_last_updated_fmt = '%b %d, %Y'
+# html_last_updated_fmt = '%b %d, %Y'
 
 # If true, SmartyPants will be used to convert quotes and dashes to
 # typographically correct entities.
-#html_use_smartypants = True
+# html_use_smartypants = True
 
 # Custom sidebar templates, maps document names to template names.
-#html_sidebars = {}
+# html_sidebars = {}
 
 # Additional templates that should be rendered to pages, maps page names to
 # template names.
-#html_additional_pages = {}
+# html_additional_pages = {}
 
 # If false, no module index is generated.
-#html_domain_indices = True
+# html_domain_indices = True
 
 # If false, no index is generated.
-#html_use_index = True
+# html_use_index = True
 
 # If true, the index is split into individual pages for each letter.
-#html_split_index = False
+# html_split_index = False
 
 # If true, links to the reST sources are added to the pages.
-#html_show_sourcelink = True
+# html_show_sourcelink = True
 
 # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
-#html_show_sphinx = True
+# html_show_sphinx = True
 
 # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
-#html_show_copyright = True
+# html_show_copyright = True
 
 # If true, an OpenSearch description file will be output, and all pages will
 # contain a <link> tag referring to it.  The value of this option must be the
 # base URL from which the finished HTML is served.
-#html_use_opensearch = ''
+# html_use_opensearch = ''
 
 # This is the file name suffix for HTML files (e.g. ".xhtml").
-#html_file_suffix = None
+# html_file_suffix = None
 
 # Output file base name for HTML help builder.
-htmlhelp_basename = 'service_identitydoc'
+htmlhelp_basename = "service_identitydoc"
 
 
 # -- Options for LaTeX output ---------------------------------------------
 
-latex_elements = {
-# The paper size ('letterpaper' or 'a4paper').
-#'papersize': 'letterpaper',
-
-# The font size ('10pt', '11pt' or '12pt').
-#'pointsize': '10pt',
-
-# Additional stuff for the LaTeX preamble.
-#'preamble': '',
-}
+latex_elements = {}
 
 # Grouping the document tree into LaTeX files. List of tuples
 # (source start file, target name, title,
 #  author, documentclass [howto, manual, or own class]).
 latex_documents = [
-    ('index', 'service_identity.tex', u'service\\_identity Documentation',
-     u'Hynek Schlawack', 'manual'),
+    (
+        "index",
+        "service_identity.tex",
+        u"service\\_identity Documentation",
+        u"Hynek Schlawack",
+        "manual",
+    )
 ]
 
 # The name of an image file (relative to this directory) to place at the top of
 # the title page.
-#latex_logo = None
+# latex_logo = None
 
 # For "manual" documents, if this is true, then toplevel headings are parts,
 # not chapters.
-#latex_use_parts = False
+# latex_use_parts = False
 
 # If true, show page references after internal links.
-#latex_show_pagerefs = False
+# latex_show_pagerefs = False
 
 # If true, show URL addresses after external links.
-#latex_show_urls = False
+# latex_show_urls = False
 
 # Documents to append as an appendix to all manuals.
-#latex_appendices = []
+# latex_appendices = []
 
 # If false, no module index is generated.
-#latex_domain_indices = True
+# latex_domain_indices = True
 
 
 # -- Options for manual page output ---------------------------------------
@@ -268,12 +262,17 @@ latex_documents = [
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
 man_pages = [
-    ('index', 'service_identity', u'service_identity Documentation',
-     [u'Hynek Schlawack'], 1)
+    (
+        "index",
+        "service_identity",
+        u"service_identity Documentation",
+        [u"Hynek Schlawack"],
+        1,
+    )
 ]
 
 # If true, show URL addresses after external links.
-#man_show_urls = False
+# man_show_urls = False
 
 
 # -- Options for Texinfo output -------------------------------------------
@@ -282,27 +281,33 @@ man_pages = [
 # (source start file, target name, title, author,
 #  dir menu entry, description, category)
 texinfo_documents = [
-    ('index', 'service_identity', u'service_identity Documentation',
-     u'Hynek Schlawack', 'service_identity',
-     'Service Identity Verification for pyOpenSSL',
-     'Miscellaneous'),
+    (
+        "index",
+        "service_identity",
+        u"service_identity Documentation",
+        u"Hynek Schlawack",
+        "service_identity",
+        "Service Identity Verification for pyOpenSSL",
+        "Miscellaneous",
+    )
 ]
 
 # Documents to append as an appendix to all manuals.
-#texinfo_appendices = []
+# texinfo_appendices = []
 
 # If false, no module index is generated.
-#texinfo_domain_indices = True
+# texinfo_domain_indices = True
 
 # How to display URL addresses: 'footnote', 'no', or 'inline'.
-#texinfo_show_urls = 'footnote'
+# texinfo_show_urls = 'footnote'
 
 # If true, do not generate a @detailmenu in the "Top" node's menu.
-#texinfo_no_detailmenu = False
+# texinfo_no_detailmenu = False
 
 
 # Example configuration for intersphinx: refer to the Python standard library.
 intersphinx_mapping = {
-    "https://docs.python.org/2/": None,
-    "https://pyopenssl.readthedocs.org/en/stable": None,
+    "https://docs.python.org/3/": None,
+    "https://pyopenssl.readthedocs.io/en/stable": None,
+    "https://cryptography.io/en/stable/": None,
 }
diff --git a/docs/contributing.rst b/docs/contributing.rst
index 1d519c3..acb527b 100644
--- a/docs/contributing.rst
+++ b/docs/contributing.rst
@@ -1,5 +1,5 @@
 .. _contributing:
 
-.. include:: ../CONTRIBUTING.rst
+.. include:: ../.github/CONTRIBUTING.rst
 
-.. include:: ../CODE_OF_CONDUCT.rst
+.. include:: ../.github/CODE_OF_CONDUCT.rst
diff --git a/docs/implemented-standards.rst b/docs/implemented-standards.rst
index 82904a6..2f18412 100644
--- a/docs/implemented-standards.rst
+++ b/docs/implemented-standards.rst
@@ -6,6 +6,7 @@ Present
 =======
 
 - ``dNSName`` with fallback to ``CN`` (DNS-ID, aka host names, `RFC 6125`_).
+- ``iPAddress`` (`RFC 2818`_).
 - ``uniformResourceIdentifier`` (URI-ID, `RFC 6125`_).
 - SRV-ID (`RFC 6125`_)
 
@@ -14,10 +15,9 @@ Future
 ======
 
 - ``xmppAddr`` (`RFC 3920`_).
-- ``iPAddress`` (`RFC 2818`_).
 - ``nameConstraints`` extensions (`RFC 3280`_).
 
-.. _`RFC 2818`: http://www.rfc-editor.org/rfc/rfc2818.txt
-.. _`RFC 3280`: http://tools.ietf.org/search/rfc3280#section-4.2.1.11
-.. _`RFC 3920`: http://www.rfc-editor.org/rfc/rfc3920.txt
-.. _`RFC 6125`: http://www.rfc-editor.org/info/rfc6125
+.. _`RFC 2818`: https://tools.ietf.org/search/rfc2818
+.. _`RFC 3280`: https://tools.ietf.org/search/rfc3280#section-4.2.1.11
+.. _`RFC 3920`: https://tools.ietf.org/search/rfc3920
+.. _`RFC 6125`: https://tools.ietf.org/search/rfc6125
diff --git a/docs/index.rst b/docs/index.rst
index 197d756..59f6776 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -1,12 +1,13 @@
-============================================
-Service Identity Verification for pyOpenSSL
-============================================
+==========================================================
+Service Identity Verification for pyOpenSSL & cryptography
+==========================================================
 
 Release v\ |release| (:doc:`What's new? <changelog>`).
 
 .. include:: ../README.rst
    :start-after: begin
 
+
 User's Guide
 ============
 
@@ -29,6 +30,7 @@ Project Information
    contributing
    changelog
 
+
 Indices and tables
 ==================
 
diff --git a/docs/installation.rst b/docs/installation.rst
index e6608b6..aed6ce2 100644
--- a/docs/installation.rst
+++ b/docs/installation.rst
@@ -14,12 +14,13 @@ Requirements
 
 Python 2.7, 3.4 and later, as well as PyPy are supported.
 
-Additionally, the following PyPI modules are required:
+Additionally, the following PyPI packages are required:
 
 - attrs_
 - pyOpenSSL_ ``>= 0.14`` (``0.12`` and ``0.13`` may work but are not part of CI anymore)
 - pyasn1_
 - pyasn1-modules_
+- ipaddress_ on Python 2.7
 
 Optionally, idna_ ``>= 0.6`` can be used for `internationalized domain names`_ (IDN), i.e. non-ASCII domains.
 Unfortunately it’s required because Python’s IDN support in the standard library is outdated_ even in the latest releases.
@@ -28,10 +29,11 @@ If you need Python 3.2 support, you will have to use the latest 0.2.x release.
 If you need Python 2.6 or 3.3 support, you will have to use the latest 14.0.x release.
 They will receive bug fix releases if necessary but other than that no further development is planned.
 
-.. _attrs: https://attrs.readthedocs.org/
-.. _pyOpenSSL: https://pypi.python.org/pypi/pyOpenSSL/
-.. _pyasn1-modules: https://pypi.python.org/pypi/pyasn1-modules/
-.. _pyasn1: https://pypi.python.org/pypi/pyasn1/
+.. _attrs: https://www.attrs.org/
+.. _pyOpenSSL: https://pypi.org/project/pyOpenSSL/
+.. _pyasn1-modules: https://pypi.org/project/pyasn1-modules/
+.. _pyasn1: https://pypi.org/project/pyasn1/
 .. _`internationalized domain names`: https://en.wikipedia.org/wiki/Internationalized_domain_name
-.. _idna: https://pypi.python.org/pypi/idna/
+.. _idna: https://pypi.org/project/idna/
 .. _outdated: https://bugs.python.org/issue17305
+.. _ipaddress: https://pypi.org/project/ipaddress/
diff --git a/docs/license.rst b/docs/license.rst
index 97abc23..3f5d090 100644
--- a/docs/license.rst
+++ b/docs/license.rst
@@ -1,7 +1,7 @@
 License
 =======
 
-``service_identity`` is licensed under the `MIT <http://choosealicense.com/licenses/mit/>`_ license.
+``service_identity`` is licensed under the `MIT <https://choosealicense.com/licenses/mit/>`_ license.
 The full license text can be also found in the `source code repository <https://github.com/pyca/service_identity/blob/master/LICENSE>`_.
 
 .. include:: ../AUTHORS.rst