ryanrampage1 · morcoteg · Oct 4, 2016 · Oct 7, 2016 · Oct 10, 2016 · Oct 14, 2016
diff --git a/README.md b/README.md
@@ -1,2 +1,69 @@
-# The Python module for Symantec VIP Services SDK Integration
-under construction!
+# Securitas
+
+Securitas is a Python library for integrating Symantec VIP two factor authentication into any application.
+
+## Installation
+
+< Temporary, could be wrong, need to test! >
+
+Install:
+
+    $ pip install securitas
+
+## Obtaining a certificate
+
+To use Securitas in your project you first need a certificate from [Symantec VIP manager](https://manager.vip.symantec.com).
+To obtain a certificate login and go to Account -> Manage VIP Certificates -> Request a Certificate. From there follow
+the directions to create a new certificate. On the download screen select the PKCS#12 format and enter the password you
+would like to use to secure the certificate.
+
+After downloading the PKCS#12 certificate, you must split it into a public and private key. To do so run the following two
+commands.
+
+Extract the private key:
+
+    $ openssl pkcs12 -in yourP12File.pfx -nocerts -out privateKey.pem
+
+Extract the public certificate:
+
+    $ openssl pkcs12 -in yourP12File.pfx -clcerts -nokeys -out publicCert.pem
+
+You may also want to remove the passphrase from the key:
+
+    $ openssl.exe rsa -in privateKey.pem -out privateKey_nopass.pem
+
+## Usage
+
+Once the certificate is split, Securitas is simple to start using.
+
+```python
+from suds.client import Client
+from symantec_package.lib.userService.SymantecUserServices import SymantecUserServices
+
+userservices_url = 'http://somelocation.io/vipuserservices-auth-1.7.wsdl'
+user_services_client = Client(userservices_url,
+      transport = HTTPSClientCertTransport( '../privateKey_nopass.pem', '../publicCert.pem'))
+
+test_user_services_object = SymantecUserServices(user_services_client)
+send_push_to_phone_result = test_user_services_object.authenticateUserWithPush("push_123", "my_mobile_device")
+# (reply){
+#   requestId = "push_123"
+#   status = "6040"
+#   statusMessage = "Mobile push request sent"
+#   transactionId = "<some_id>"
+#   pushDetail =
+#      (PushDetailType){
+#         pushCredentialId = "<some_credential_id>"
+#         pushSent = True
+#      }
+# }
+
+```
+
+## Documentation
+
+< Need to provide link once published! >
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/ryanrampage1/Securitas. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
diff --git a/docs/Makefile b/docs/Makefile
@@ -0,0 +1,19 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+SPHINXPROJ    = SymantecVIPPython
+SOURCEDIR     = source
+BUILDDIR      = build
+
+help:
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
diff --git a/docs/build/doctrees/VIP_Python/modules.doctree b/docs/build/doctrees/VIP_Python/modules.doctree
diff --git a/docs/build/doctrees/VIP_Python/symantec_package.doctree b/docs/build/doctrees/VIP_Python/symantec_package.doctree
diff --git a/docs/build/doctrees/VIP_Python/symantec_package.lib.allServices.doctree b/docs/build/doctrees/VIP_Python/symantec_package.lib.allServices.doctree
diff --git a/docs/build/doctrees/VIP_Python/symantec_package.lib.doctree b/docs/build/doctrees/VIP_Python/symantec_package.lib.doctree
diff --git a/docs/build/doctrees/VIP_Python/symantec_package.lib.managementService.doctree b/docs/build/doctrees/VIP_Python/symantec_package.lib.managementService.doctree
diff --git a/docs/build/doctrees/VIP_Python/symantec_package.lib.queryService.doctree b/docs/build/doctrees/VIP_Python/symantec_package.lib.queryService.doctree
diff --git a/docs/build/doctrees/VIP_Python/symantec_package.lib.userService.doctree b/docs/build/doctrees/VIP_Python/symantec_package.lib.userService.doctree
diff --git a/docs/build/doctrees/environment.pickle b/docs/build/doctrees/environment.pickle
diff --git a/docs/build/doctrees/index.doctree b/docs/build/doctrees/index.doctree
diff --git a/docs/build/html/.buildinfo b/docs/build/html/.buildinfo
@@ -0,0 +1,4 @@
+# Sphinx build info version 1
+# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: 740e7d3e3c725e0d31cbebdaaa287ee2
+tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/docs/build/html/VIP_Python/modules.html b/docs/build/html/VIP_Python/modules.html
@@ -0,0 +1,117 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+
+<html xmlns="http://www.w3.org/1999/xhtml">
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+
+    <title>symantec_package &#8212; Symantec VIP Python  documentation</title>
+
+    <link rel="stylesheet" href="../_static/classic.css" type="text/css" />
+    <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
+
+    <script type="text/javascript">
+      var DOCUMENTATION_OPTIONS = {
+        URL_ROOT:    '../',
+        VERSION:     '',
+        COLLAPSE_INDEX: false,
+        FILE_SUFFIX: '.html',
+        HAS_SOURCE:  true,
+        SOURCELINK_SUFFIX: '.txt'
+      };
+    </script>
+    <script type="text/javascript" src="../_static/jquery.js"></script>
+    <script type="text/javascript" src="../_static/underscore.js"></script>
+    <script type="text/javascript" src="../_static/doctools.js"></script>
+    <script type="text/javascript" src="../_static/sidebar.js"></script>
+    <link rel="index" title="Index" href="../genindex.html" />
+    <link rel="search" title="Search" href="../search.html" /> 
+  </head>
+  <body role="document">
+    <div class="related" role="navigation" aria-label="related navigation">
+      <h3>Navigation</h3>
+      <ul>
+        <li class="right" style="margin-right: 10px">
+          <a href="../genindex.html" title="General Index"
+             accesskey="I">index</a></li>
+        <li class="right" >
+          <a href="../py-modindex.html" title="Python Module Index"
+             >modules</a> |</li>
+        <li class="nav-item nav-item-0"><a href="../index.html">Symantec VIP Python  documentation</a> &#187;</li> 
+      </ul>
+    </div>  
+
+    <div class="document">
+      <div class="documentwrapper">
+        <div class="bodywrapper">
+          <div class="body" role="main">
+
+  <div class="section" id="symantec-package">
+<h1>symantec_package<a class="headerlink" href="#symantec-package" title="Permalink to this headline">¶</a></h1>
+<div class="toctree-wrapper compound">
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="symantec_package.html">symantec_package package</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="symantec_package.html#subpackages">Subpackages</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="symantec_package.lib.html">symantec_package.lib package</a><ul>
+<li class="toctree-l4"><a class="reference internal" href="symantec_package.lib.html#subpackages">Subpackages</a></li>
+<li class="toctree-l4"><a class="reference internal" href="symantec_package.lib.html#module-symantec_package.lib">Module contents</a></li>
+</ul>
+</li>
+</ul>
+</li>
+<li class="toctree-l2"><a class="reference internal" href="symantec_package.html#submodules">Submodules</a></li>
+<li class="toctree-l2"><a class="reference internal" href="symantec_package.html#module-symantec_package.HTTPHandler">symantec_package.HTTPHandler module</a></li>
+<li class="toctree-l2"><a class="reference internal" href="symantec_package.html#symantec-package-soap-play-module">symantec_package.soap-play module</a></li>
+<li class="toctree-l2"><a class="reference internal" href="symantec_package.html#module-symantec_package">Module contents</a></li>
+</ul>
+</li>
+</ul>
+</div>
+</div>
+
+
+          </div>
+        </div>
+      </div>
+      <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
+        <div class="sphinxsidebarwrapper">
+  <div role="note" aria-label="source link">
+    <h3>This Page</h3>
+    <ul class="this-page-menu">
+      <li><a href="../_sources/VIP_Python/modules.rst.txt"
+            rel="nofollow">Show Source</a></li>
+    </ul>
+   </div>
+<div id="searchbox" style="display: none" role="search">
+  <h3>Quick search</h3>
+    <form class="search" action="../search.html" method="get">
+      <div><input type="text" name="q" /></div>
+      <div><input type="submit" value="Go" /></div>
+      <input type="hidden" name="check_keywords" value="yes" />
+      <input type="hidden" name="area" value="default" />
+    </form>
+</div>
+<script type="text/javascript">$('#searchbox').show(0);</script>
+        </div>
+      </div>
+      <div class="clearer"></div>
+    </div>
+    <div class="related" role="navigation" aria-label="related navigation">
+      <h3>Navigation</h3>
+      <ul>
+        <li class="right" style="margin-right: 10px">
+          <a href="../genindex.html" title="General Index"
+             >index</a></li>
+        <li class="right" >
+          <a href="../py-modindex.html" title="Python Module Index"
+             >modules</a> |</li>
+        <li class="nav-item nav-item-0"><a href="../index.html">Symantec VIP Python  documentation</a> &#187;</li> 
+      </ul>
+    </div>
+    <div class="footer" role="contentinfo">
+        &#169; Copyright 2016, Symantec VIP.
+      Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.5a2.
+    </div>
+  </body>
+</html>