Class EnrollServlet

  • All Implemented Interfaces:
    java.io.Serializable, javax.servlet.Servlet, javax.servlet.ServletConfig

    public class EnrollServlet
    extends CMSServlet
    Submit a Certificate Enrollment request
    Version:
    $Revision$, $Date$
    See Also:
    Serialized Form
    • Constructor Detail

      • EnrollServlet

        public EnrollServlet()
    • Method Detail

      • init

        public void init​(javax.servlet.ServletConfig sc)
                  throws javax.servlet.ServletException
        initialize the servlet.

        the following parameters are read from the servlet config:

        • CMSServlet.PROP_ID - ID for signed audit log messages
        • CMSServlet.PROP_SUCCESS_TEMPLATE - success template file
        Specified by:
        init in interface javax.servlet.Servlet
        Overrides:
        init in class CMSServlet
        Parameters:
        sc - servlet configuration, read from the web.xml file
        Throws:
        javax.servlet.ServletException
      • getEnforcePop

        public boolean getEnforcePop()
        XXX (SHOULD CHANGE TO READ FROM Servletconfig) Getter method to see if Proof of Posession checking is enabled. this value is set in the CMS.cfg filem with the parameter "enrollment.enforcePop". It defaults to false
        Returns:
        true if user is required to Prove that they possess the private key corresponding to the public key in the certificate request they are submitting
      • process

        protected void process​(CMSRequest cmsReq)
                        throws EBaseException
        Process the HTTP request.
        • If the request is coming through the admin port, it is only allowed to continue if 'admin enrollment' is enabled in the CMS.cfg file
        • If the CMS.cfg parameter useThreadNaming is true, the current thread is renamed with more information about the current request ID
        • The request is preprocessed, then processed further in one of the cert request processor classes: KeyGenProcessor, PKCS10Processor, CMCProcessor, CRMFProcessor
        Overrides:
        process in class CMSServlet
        Parameters:
        cmsReq - the object holding the request and response information
        Throws:
        EBaseException - if the servlet was unable to satisfactorily process the request
      • processX509

        protected void processX509​(CMSRequest cmsReq)
                            throws EBaseException
        Process X509 certificate enrollment request

        (Certificate Request - either an "admin" cert request for an admin certificate, an "agent" cert request for "bulk enrollment", or an "EE" standard cert request)

        (Certificate Request Processed - either an automated "admin" non-profile based CA admin cert acceptance, an automated "admin" non-profile based CA admin cert rejection, an automated "EE" non-profile based cert acceptance, or an automated "EE" non-profile based cert rejection)

        • signed.audit LOGGING_SIGNED_AUDIT_NON_PROFILE_CERT_REQUEST used when a non-profile cert request is made (before approval process)
        • signed.audit LOGGING_SIGNED_AUDIT_CERT_REQUEST_PROCESSED used when a certificate request has just been through the approval process
        Parameters:
        cmsReq - a certificate enrollment request
        Throws:
        EBaseException - an error has occurred
      • renderServerEnrollResult

        protected void renderServerEnrollResult​(CMSRequest cmsReq)
                                         throws java.io.IOException
        Throws:
        java.io.IOException