ConnectCertificate.idl

Go to the documentation of this file.

 /**
 * @file   ConnectCertificate.idl
 * @brief  Set security certificates. Methods specific for Kerio Connect.
 *
 * @author Dusan Juhas
 *
 * @copyright Copyright © 2017 Kerio Technologies s.r.o.
 */

#import <kerio/web/idl/SharedStructures.idl>
#include <kerio/web/idl/Certificates.idl>

module kerio {
module jsonapi {
module admin {

typedef sequence<kerio::web::Certificate> CertificateList;

interface ConnectCertificate {

   /**
    * Export of certificate or certificate request
    * Note: "export" is a keyword in C++, so name of the method must be changed: exportCertificate
    *
    * @param id - ID of the certificate or certificate request
    * @param fileDownload - description of the output file
    */
   void exportCertificate(out kerio::web::Download fileDownload, in kerio::web::KId id);

   /**
    * Export of certificate or request privatekey
    * Note: "export" is a keyword in C++, so the name of the method must be changed: exportPrivateKey
    *
    * @param id - ID of the certificate or certificate request
    * @param fileDownload - description of the output file
    */
   void exportPrivateKey(out kerio::web::Download fileDownload, in kerio::web::KId id);

   /**
    * Obtain a list of certificates
    *
    * @param certificates - current list of certificates
    */
   void get(out CertificateList certificates);

   /**
    * Generate a self-signed certificate
    *
    * @param id - ID of the new generated certificate
    * @param subject - information about subject
    * @param valid - length of the certificate's validity (in years, max value is 10)
    */
   void generate(out kerio::web::KId id, in kerio::web::NamedValueList subject, in long valid);

   /**
    * Generate certificate request
    *
    * @param id - ID of the new generated certificate request
    * @param subject - information about subject
    */
   void generateRequest(out kerio::web::KId id, in kerio::web::NamedValueList subject);

   /**
    * Import private key for the new certificate.
    *
    * @param needPassword - true if private key is encrypted with password
    * @param id - ID of private key or certificate request which belongs to the certificate
    * @param fileId - ID of the uploaded file
    * @param password - certificate password, if it is set (use empty string if password is not set)
    */
   void importCertificate(in kerio::web::KId id, in string fileId, in string password);

   /**
    * Import private key for the new certificate.
    *
    * @param needPassword - true if private key is encrypted with password
    * @param id - temporary ID to assign certificate to private key
    * @param fileId - ID of the uploaded file
    */
   void importPrivateKey(out boolean needPassword, out kerio::web::KId id, in string fileId);

   /**
    * Remove list of certificate records
    *
    * @param errors - error message list
    * @param ids - list of identifiers of deleted user templates
    */
   void remove(out kerio::web::ErrorList errors, in kerio::web::KIdList certificateIds);

   /**
    * Set active certificate
    *
    * @param id - ID of the new active certificate
    */
   void setActive(in kerio::web::KId id);

   /**
    * Obtain source (plain-text representation) of the certificate
    *
    * @param source - certificate in plain text
    * @param id - global identifier
    */
   void toSource(out string source, in kerio::web::KId id);
};

}; }; };//end of namespace