Source code for SoftLayer.managers.ssl

"""
    SoftLayer.ssl
    ~~~~~~~~~~~~~
    SSL Manager/helpers

    :copyright: (c) 2013, SoftLayer Technologies, Inc. All rights reserved.
    :license: MIT, see LICENSE for more details.
"""


[docs]class SSLManager(object):
    """
    Manages SSL certificates.

    :param SoftLayer.API.Client client: an API client instance
    """

    def __init__(self, client):
        #: A valid `SoftLayer.API.Client` object that will be used for all
        #: actions.
        self.client = client
        #: Reference to the SoftLayer_Security_Certificate API object.
        self.ssl = self.client['Security_Certificate']

[docs]    def list_certs(self, method='all'):
        """ List all certificates.

        :param string method: The type of certificates to list. Options are
                              'all', 'expired', and 'valid'.
        :returns: A list of dictionaries representing the requested SSL certs.

        """
        ssl = self.client['Account']
        methods = {
            'all': 'getSecurityCertificates',
            'expired': 'getExpiredSecurityCertificates',
            'valid': 'getValidSecurityCertificates'
        }

        mask = "mask[id, commonName, validityDays, notes]"
        func = getattr(ssl, methods[method])
        return func(mask=mask)

[docs]    def add_certificate(self, certificate):
        """ Creates a new certificate.

        :param dict certificate: A dictionary representing the parts of the
                                 certificate. See SLDN for more information.

        """
        return self.ssl.createObject(certificate)

[docs]    def remove_certificate(self, cert_id):
        """ Removes a certificate.

        :param integer cert_id: a certificate ID to remove

        """
        return self.ssl.deleteObject(id=cert_id)

[docs]    def edit_certificate(self, certificate):
        """ Updates a certificate with the included options.

        The provided dict must include an 'id' key and value corresponding to
        the certificate ID that should be updated.

        :param dict certificate: the certificate to update.

        """
        return self.ssl.editObject(certificate, id=certificate['id'])

[docs]    def get_certificate(self, cert_id):
        """ Gets a certificate with the ID specified.

        :param integer cert_id: the certificate ID to retrieve

        """
        return self.ssl.getObject(id=cert_id)