python-securepass 0.4.3-1 / usr / lib / python2.7 / dist-packages / securepass / securepass.py

##
## Generic SecurePass Class to access APIs of Dreamliner
## www.secure-pass.net
##
## This code is released under GPLv2
##
## Contains some code from Ganeti project (c) Google Inc.
## Copyright (C) 2010, 2011, 2012 Google Inc
##
## This library is under development, please sync from:
## https://github.com/gpaterno/securepass-tools
##
## (c) 2013 Giuseppe Paterno' (gpaterno@gpaterno.com)
##          GARL Sagl (www.garl.ch)
##

import logging
import pycurl
import json
import urllib
from StringIO import StringIO

HTTP_APP_JSON = "application/json"
USER_AGENT = "SecurePass CLI"
HTTP_GET = "GET"
HTTP_PUT = "PUT"
HTTP_POST = "POST"

# Older pycURL versions don't have all error constants
try:
  _CURLE_SSL_CACERT = pycurl.E_SSL_CACERT
  _CURLE_SSL_CACERT_BADFILE = pycurl.E_SSL_CACERT_BADFILE
except AttributeError:
  _CURLE_SSL_CACERT = 60
  _CURLE_SSL_CACERT_BADFILE = 77

_CURL_SSL_CERT_ERRORS = frozenset([
  _CURLE_SSL_CACERT,
  _CURLE_SSL_CACERT_BADFILE,
  ])

class SecurePass(object):

    def __init__(self, app_id=None, app_secret=None, endpoint=None, logger=logging):
        """ Inizialize the class
        """

        self.app_id = app_id
        self.app_secret = app_secret
        self._logger = logger

        if endpoint is not None:
            self.endpoint = endpoint
        else:
            self.endpoint = "https://beta.secure-pass.net/"


    def _SendRequest(self, method, path, content=None):

        """Sending CURL request
           Method is GET/POST
           Path is the subpath of the request
           Content is a dictionary
        """
        assert path.startswith("/")

        curl = pycurl.Curl()

        # Default cURL settings
        curl.setopt(pycurl.VERBOSE, False)
        curl.setopt(pycurl.FOLLOWLOCATION, False)
        curl.setopt(pycurl.MAXREDIRS, 5)
        curl.setopt(pycurl.NOSIGNAL, True)
        curl.setopt(pycurl.USERAGENT, USER_AGENT)
        curl.setopt(pycurl.SSL_VERIFYHOST, 0)
        curl.setopt(pycurl.SSL_VERIFYPEER, False)
        curl.setopt(pycurl.HTTPHEADER, [
          "Accept: %s" % HTTP_APP_JSON,
          "Content-type: %s" % HTTP_APP_JSON,
          "X-SecurePass-App-ID: %s" % self.app_id,
          "X-SecurePass-App-Secret: %s" % self.app_secret,
          ])

        url = "%s%s" % (self.endpoint, path)

        self._logger.debug("Sending request %s %s (content=%r)",
                           method, url, content)

        # Buffer for response
        encoded_resp_body = StringIO()

        # Configure cURL
        curl.setopt(pycurl.CUSTOMREQUEST, str(method))
        curl.setopt(pycurl.URL, str(url))
        curl.setopt(pycurl.WRITEFUNCTION, encoded_resp_body.write)

        if content is not None:
            curl.setopt(pycurl.POSTFIELDS, urllib.urlencode(content))

        try:
          # Send request and wait for response
          try:
            curl.perform()
          except pycurl.error as err:
            if err.args[0] in _CURL_SSL_CERT_ERRORS:
              self._logger.error("SSL certificate error %s" % err,
                                  code=err.args[0])

        finally:
          # Reset settings to not keep references to large objects in memory
          # between requests
          curl.setopt(pycurl.POSTFIELDS, "")
          curl.setopt(pycurl.WRITEFUNCTION, lambda _: None)

        # Was anything written to the response buffer?
        if encoded_resp_body.tell():
          response_content = json.loads(encoded_resp_body.getvalue())
        else:
          response_content = None

        return response_content


    ##
    ## SecurePass Utilities
    ##

    def ping(self):
        """ Ping the SecurePass server and get some information
        """
        response = self._SendRequest(HTTP_GET, "/api/v1/ping")

        if response['rc'] == 0:
            return "Ping from IPv%s address %s" % (response['ip_version'], response['ip'])
        else:
            raise Exception(response['errorMsg'])

    def log(self, message=""):
        """ Log a message to the central logging facility
        """

        request = {}
        request['MESSAGE'] = message
        response = self._SendRequest(HTTP_POST, "/api/v1/logs/log", content=request)

        if response['rc'] == 0:
            print "Log sent"
        else:
            print response['errorMsg']


    def get_logs(self, realm=None, start=None, end=None):
        """ Get the list of logs
        """

        request = {}

        if realm is not None:
            request['REALM'] = realm

        ## Start date
        if start is not None:
            request['START'] = start

        ## End date
        if end is not None:
            request['END'] = end

        response = self._SendRequest(HTTP_POST, "/api/v1/logs/get", content=request)

        if response['rc'] == 0:

            del response['rc']
            del response['errorMsg']

            return response

        else:
            raise Exception(response['errorMsg'])


    ##
    ## SecurePass Application handling
    ##

    # List apps
    def app_list(self, realm=None):
        """ Get the list of applications in your realm
        """

        request = {}
        tmpapp = []

        if realm is not None:
            request['REALM'] = realm

        response = self._SendRequest(HTTP_POST, "/api/v1/apps/list", content=request)

        if response['rc'] == 0:
            for app in response['APP_ID']:
                tmpapp.append(app)

            return tmpapp
        else:
            raise Exception(response['errorMsg'])


    # Application info
    def app_info(self, app_id=None):
        """ Get information about given application
        """

        request = {}
        if app_id is not None:
            request['APP_ID'] = app_id

        response = self._SendRequest(HTTP_POST, "/api/v1/apps/info", content=request)

        if response['rc'] == 0:

            del response['rc']
            del response['errorMsg']

            return response

        else:
            raise Exception(response['errorMsg'])

    # Create application
    def app_add(self, label="", allow_network_ipv4=None, allow_network_ipv6=None,
                write=False, privacy=False, group=None, realm=None):
        """ Add an application to SecurePass
        """

        request = {}

        request['LABEL'] = label
        request['WRITE'] = write
        request['PRIVACY'] = privacy

        if allow_network_ipv4 is not None:
            request['ALLOW_NETWORK_IPv4'] = allow_network_ipv4

        if allow_network_ipv6 is not None:
            request['ALLOW_NETWORK_IPv6'] = allow_network_ipv6

        if group is not None:
            request['GROUP'] = group

        if realm is not None:
            request['REALM'] = realm


        response = self._SendRequest(HTTP_POST, "/api/v1/apps/add", content=request)

        if response['rc'] == 0:

            del response['rc']
            del response['errorMsg']

            return response

        else:
            raise Exception(response['errorMsg'])


    # Delete The application
    def app_delete(self, app_id=None):
        """ Delete an application
        """

        request = {}
        if app_id is not None:
            request['APP_ID'] = app_id

        response = self._SendRequest(HTTP_POST, "/api/v1/apps/delete", content=request)

        if response['rc'] == 0:

            del response['rc']
            del response['errorMsg']

            return response

        else:
            raise Exception(response['errorMsg'])


    ## Modify the application
    # Create application
    def app_modify(self, app_id=None, label=None, allow_network_ipv4=None, allow_network_ipv6=None,
                write=None, privacy=None, group=None, realm=None):
        """ Modify an application in SecurePass
        """

        request = {}

        if app_id is not None:
            request['APP_ID'] = app_id

        if label is not None:
            request['LABEL'] = label

        if write is not None:
            request['WRITE'] = write

        if privacy is not None:
            request['PRIVACY'] = privacy

        if allow_network_ipv4 is not None:
            request['ALLOW_NETWORK_IPv4'] = allow_network_ipv4

        if allow_network_ipv6 is not None:
            request['ALLOW_NETWORK_IPv6'] = allow_network_ipv6

        if group is not None:
            request['GROUP'] = group

        if realm is not None:
            request['REALM'] = realm


        response = self._SendRequest(HTTP_POST, "/api/v1/apps/modify", content=request)

        if response['rc'] == 0:

            del response['rc']
            del response['errorMsg']

            return response

        else:
            raise Exception(response['errorMsg'])


    ##
    ## SecurePass Users handling
    ##

    # List users
    def user_list(self, realm=None):
        """ Get the list of applications in your realm
        """

        request = {}
        tmpuser = []

        if realm is not None:
            request['REALM'] = realm

        response = self._SendRequest(HTTP_POST, "/api/v1/users/list", content=request)

        if response['rc'] == 0:
            for user in response['username']:
                tmpuser.append(user)

            return tmpuser
        else:
            raise Exception(response['errorMsg'])

    ## Get user info
    def user_info(self, user=None):
        """ Get the details of a user in your realm
        """

        request = {}

        if user is not None:
            request['USERNAME'] = user

        response = self._SendRequest(HTTP_POST, "/api/v1/users/info", content=request)

        if response['rc'] == 0:
            del response['rc']
            del response['errorMsg']

            return response

        else:
            raise Exception(response['errorMsg'])

    ## Authenticate user
    def user_auth(self, user=None, secret=None):
        """ Authenticate the user
        """

        request = {}

        if user is not None:
            request['USERNAME'] = user

        if secret is not None:
            request['SECRET'] = secret


        response = self._SendRequest(HTTP_POST, "/api/v1/users/auth", content=request)

        if response['rc'] == 0:
            return response['authenticated']

        else:
            raise Exception(response['errorMsg'])


    ## Add a user
    def user_add(self, user=None, name=None, surname=None,
                 email=None, mobile=None, nin=None, rfid=None, manager=None):
        """ Add a user into the realm
        """

        request = {}

        if user is not None:
            request['USERNAME'] = user

        if name is not None:
            request['NAME'] = name

        if surname is not None:
            request['SURNAME'] = surname

        if email is not None:
            request['EMAIL'] = email

        if mobile is not None:
            request['MOBILE'] = mobile

        if nin is not None:
            request['NIN'] = nin

        if rfid is not None:
            request['RFID'] = rfid

        if manager is not None:
            request['MANAGER'] = manager

        response = self._SendRequest(HTTP_POST, "/api/v1/users/add", content=request)

        if response['rc'] == 0:
            return response['username']

        else:
            raise Exception(response['errorMsg'])


    ## Remove a user
    def user_del(self, user=None):
        """ Remove a user
        """

        request = {}

        if user is not None:
            request['USERNAME'] = user

        response = self._SendRequest(HTTP_POST, "/api/v1/users/delete", content=request)

        if response['rc'] == 0:
            return True

        else:
            raise Exception(response['errorMsg'])


    ## Remove a user
    def user_provision(self, user=None, swtoken=None):
        """ Provision a user
        """

        request = {}
        SWTOKENS = ('iphone', 'android', 'blackberry', 'software')

        if user is not None:
            request['USERNAME'] = user

        if swtoken is not None and swtoken.lower() in SWTOKENS:
            request['SWTOKEN'] = swtoken.lower()

        response = self._SendRequest(HTTP_POST, "/api/v1/users/token/provision", content=request)

        if response['rc'] == 0:
            return True

        else:
            raise Exception(response['errorMsg'])



    ## Change user password
    def user_password_change(self, user=None, password=None):
        """ Change user password
        """

        request = {}

        if user is not None:
            request['USERNAME'] = user

        if password is not None:
            request['PASSWORD'] = password

        response = self._SendRequest(HTTP_POST, "/api/v1/users/password/change", content=request)

        if response['rc'] == 0:
            return True

        else:
            raise Exception(response['errorMsg'])

    ## Disable user password
    def user_password_disable(self, user=None):
        """ Disable password
        """

        request = {}

        if user is not None:
            request['USERNAME'] = user

        response = self._SendRequest(HTTP_POST, "/api/v1/users/password/disable", content=request)

        if response['rc'] == 0:
            return True

        else:
            raise Exception(response['errorMsg'])


    ## Disable user
    def user_disable(self, user=None):
        """ Disable user
        """

        request = {}

        if user is not None:
            request['USERNAME'] = user

        response = self._SendRequest(HTTP_POST, "/api/v1/users/disable", content=request)

        if response['rc'] == 0:
            return True

        else:
            raise Exception(response['errorMsg'])


    ## Enable user
    def user_enable(self, user=None):
        """ Enable a given user
        """

        request = {}

        if user is not None:
            request['USERNAME'] = user

        response = self._SendRequest(HTTP_POST, "/api/v1/users/enable", content=request)

        if response['rc'] == 0:
            return True

        else:
            raise Exception(response['errorMsg'])


    ##
    ## SecurePass users' extended attributes (xattr)
    ##

    def users_xattr_list(self, user=None):
        """ Get Users' extended attributes
        """

        request = {}

        if user is not None:
            request['USERNAME'] = user

        response = self._SendRequest(HTTP_POST, "/api/v1/users/xattrs/list", content=request)

        if response['rc'] == 0:
            del response['rc']
            del response['errorMsg']

            return response

        else:
            raise Exception(response['errorMsg'])


    def users_xattr_set(self, user=None, attribute=None, value=None):
        """ Set Users' extended attributes
        """

        request = {}

        if user is not None:
            request['USERNAME'] = user

        if attribute is not None:
            request['ATTRIBUTE'] = attribute

        if value is not None:
            request['VALUE'] = value

        response = self._SendRequest(HTTP_POST, "/api/v1/users/xattrs/set", content=request)

        if response['rc'] == 0:
            del response['rc']
            del response['errorMsg']

            return response

        else:
            raise Exception(response['errorMsg'])


    def users_xattr_delete(self, user=None, attribute=None):
        """ Delete  Users' extended attribute
        """

        request = {}

        if user is not None:
            request['USERNAME'] = user

        if attribute is not None:
            request['ATTRIBUTE'] = attribute

        response = self._SendRequest(HTTP_POST, "/api/v1/users/xattrs/delete", content=request)

        if response['rc'] == 0:
            del response['rc']
            del response['errorMsg']

            return response

        else:
            raise Exception(response['errorMsg'])


    ##
    ## SecurePass Realms extended attributes (xattr)
    ##

    def realms_xattr_list(self, realm=None):
        """ Get Users' extended attributes
        """

        request = {}

        if realm is not None:
            request['REALM'] = realm

        response = self._SendRequest(HTTP_POST, "/api/v1/realms/xattrs/list", content=request)

        if response['rc'] == 0:
            del response['rc']
            del response['errorMsg']

            return response

        else:
            raise Exception(response['errorMsg'])


    def realms_xattr_set(self, realm=None, attribute=None, value=None):
        """ Set Users' extended attributes
        """

        request = {}

        if realm is not None:
            request['REALM'] = realm

        if attribute is not None:
            request['ATTRIBUTE'] = attribute

        if value is not None:
            request['VALUE'] = value

        response = self._SendRequest(HTTP_POST, "/api/v1/realms/xattrs/set", content=request)

        if response['rc'] == 0:
            del response['rc']
            del response['errorMsg']

            return response

        else:
            raise Exception(response['errorMsg'])


    def realms_xattr_delete(self, realm=None, attribute=None):
        """ Delete  Users' extended attribute
        """

        request = {}

        if realm is not None:
            request['REALM'] = realm

        if attribute is not None:
            request['ATTRIBUTE'] = attribute

        response = self._SendRequest(HTTP_POST, "/api/v1/realms/xattrs/delete", content=request)

        if response['rc'] == 0:
            del response['rc']
            del response['errorMsg']

            return response

        else:
            raise Exception(response['errorMsg'])



    ##
    ## SecurePass Group handling
    ##
    def group_member(self, user=None, group=None):
        """ Check if user is member of a group
        """

        request = {}

        if user is not None:
            request['USERNAME'] = user

        if group is not None:
            request['GROUP'] = group


        response = self._SendRequest(HTTP_POST, "/api/v1/groups/member", content=request)

        if response['rc'] == 0:
            return response['member']

        else:
            raise Exception(response['errorMsg'])



    ##
    ## SecurePass RADIUS handling
    ##

    ## List the radiuses
    def radius_list(self, realm=None):
        """ Lists RADIUS devices in a realm
        """

        request = {}
        tmpradius = []

        if realm is not None:
            request['REALM'] = realm


        response = self._SendRequest(HTTP_POST, "/api/v1/radius/list", content=request)

        if response['rc'] == 0:
            for radius in response['radius']:
                tmpradius.append(radius)

            return tmpradius
        else:
            raise Exception(response['errorMsg'])


    ## Radius info
    def radius_info(self, radius=None):
        """ Get the details of a RADIUS in your realm
        """

        request = {}

        if radius is not None:
            request['RADIUS'] = radius

        response = self._SendRequest(HTTP_POST, "/api/v1/radius/info", content=request)

        if response['rc'] == 0:
            del response['rc']
            del response['errorMsg']

            return response

        else:
            raise Exception(response['errorMsg'])


    ## Delete Radius
    def radius_del(self, radius=None):
        """ Remove a RADIUS device
        """

        request = {}

        if radius is not None:
            request['RADIUS'] = radius

        response = self._SendRequest(HTTP_POST, "/api/v1/radius/delete", content=request)

        if response['rc'] == 0:
            return True

        else:
            raise Exception(response['errorMsg'])

    ## Modify a radius
    def radius_modify(self, radius=None, name=None, secret=None,
                      rfid=None, group=None, realm=None):
        """ Modify a RADIUS device
        """

        request = {}

        if radius is not None:
            request['RADIUS'] = radius

        if name is not None:
            request['NAME'] = name

        if secret is not None:
            request['SECRET'] = secret

        if rfid is not None:
            request['RFID'] = rfid

        if group is not None:
            request['GROUP'] = group

        if realm is not None:
            request['REALM'] = realm

        response = self._SendRequest(HTTP_POST, "/api/v1/radius/modify", content=request)

        if response['rc'] == 0:

            del response['rc']
            del response['errorMsg']

            return response

        else:
            raise Exception(response['errorMsg'])


    ## Add a radius
    def radius_add(self, radius=None, name=None, secret=None,
                          rfid=None, group=None, realm=None):
        """ Add a RADIUS device
        """

        request = {}

        if radius is not None:
            request['RADIUS'] = radius

        if name is not None:
            request['NAME'] = name

        if secret is not None:
            request['SECRET'] = secret

        if rfid is not None:
            request['RFID'] = rfid

        if group is not None:
            request['GROUP'] = group

        if realm is not None:
            request['REALM'] = realm

        response = self._SendRequest(HTTP_POST, "/api/v1/radius/add", content=request)

        if response['rc'] == 0:

            del response['rc']
            del response['errorMsg']

            return response

        else:
            raise Exception(response['errorMsg'])


    ##
    ## SecurePass Realm handling xattrs/global policies
    ##

    def realm_xattr_list(self, realm=None):
        """ Get Realm' extended attributes
        """

        request = {}

        if realm is not None:
            request['REALM'] = realm

        response = self._SendRequest(HTTP_POST, "/api/v1/realms/xattrs/list", content=request)

        if response['rc'] == 0:
            del response['rc']
            del response['errorMsg']

            return response

        else:
            raise Exception(response['errorMsg'])


    def realm_xattr_set(self, realm=None, attribute=None, value=None):
        """ Set Realm' extended attributes
        """

        request = {}

        if realm is not None:
            request['REALM'] = realm

        if attribute is not None:
            request['ATTRIBUTE'] = attribute

        if value is not None:
            request['VALUE'] = value

        response = self._SendRequest(HTTP_POST, "/api/v1/realms/xattrs/set", content=request)

        if response['rc'] == 0:
            del response['rc']
            del response['errorMsg']

            return response

        else:
            raise Exception(response['errorMsg'])


    def realm_xattr_delete(self, realm=None, attribute=None):
        """ Delete  Realm' extended attribute
        """

        request = {}

        if realm is not None:
            request['REALM'] = realm

        if attribute is not None:
            request['ATTRIBUTE'] = attribute

        response = self._SendRequest(HTTP_POST, "/api/v1/realms/xattrs/delete", content=request)

        if response['rc'] == 0:
            del response['rc']
            del response['errorMsg']

            return response

        else:
            raise Exception(response['errorMsg'])