With Application Gateway Integration
Microsoft Azure Application Gateway
Permissions Required
{
"properties": {
"roleName": "AppViewX_AppGW_Permission",
"description": "",
"assignableScopes": [
"/subscriptions/000-000-000-0000-000"
],
"permissions": [
{
"actions": [
"Microsoft.Network/applicationGateways/write",
"Microsoft.Network/applicationGateways/read",
"Microsoft.Network/applicationGatewayAvailableSslOptions/predefinedPolicies/read",
"Microsoft.Network/applicationGatewayAvailableSslOptions/read",
"Microsoft.Network/virtualNetworks/subnets/join/action",
"Microsoft.ManagedIdentity/userAssignedIdentities/assign/action"
],
"notActions": [],
"dataActions": [],
"notDataActions": []
}
]
}
}
Onboarding Azure Settings in AppViewX for Key Vault
-
Go to
(Menu) > CERT+ >
ADMINISTRATION > Device Management.
The Device :: ADC page is displayed. - From the Device :: ADC page, select Cloud.
-
On the Device :: Cloud page, click
(Add).
The Device :: Cloud > Add page is displayed. - On the Device :: Cloud > Add page, from the list of Vendors, select Azure.
-
Enter/Select the Basic information.
Table 1. Field description for the Basic Information section Field Description *Account name Enter the customer’s unique account name.
Constraints:
- A duplicate account name should not exist in the cloud inventory.
- The account name should include only alphanumeric and period (.) characters.
Description Enter a description of the device to be added. *Data center From the dropdown list, select the data center through which communication with the Certificate Authority will be established. Proxy required To use a proxy server for the communication, select this checkbox. *: Mandatory fields -
Enter/Select the Key information.
Table 2. Field description for the Key information section Field Description *Subscription ID Enter the customer’s Azure subscription ID. *Tenant ID Enter the customer’s Azure tenant ID. *Client ID Enter the customer’s Azure client ID. *Client secret Enter the customer’s Azure client secret key. *Services From the dropdown list, select Application Gateway to map the service to the Azure setting. Auto Sync To enable/disable automatic synchronization of the AppViewX inventory with your Azure cloud infrastructure , use the Auto Sync key.
On enabling auto sync, the Schedule Based checkbox is displayed
Schedule Based To specify a schedule for the auto sync: - Click the
icon.The Schedule Based Sync window is displayed.
- In the General Information section, enter the details of the sync schedule.
*: Mandatory fields Table 3. Field descriptions for the General Information section Field Description *Frequency of Sync Set the sync frequency using the two dropdown lists for this field. For example, to set the frequency to 1 day: - From the first dropdown list, select 1.
- From the second dropdown list, select Days.
Advance Settings To set the sync frequency for a specific service: - Enable the Advance Settings key.
The Auto Sync Services section is displayed. The services selected for this setting (in the Services field under Key Information) are listed in this section.
- To set the frequency for a specific service(s),
select the corresponding checkbox.
The Frequency of Sync field is displayed for the selected service(s).
- Enter the details of the sync schedule and click
Apply.
The sync frequency is applied to the selected services.
Note: If a service is not selected, the Frequency of Sync set in the General Information section is applied to all services in a setting.
- Click the
-
From Additional attributes, for the required services, select the
user permission for Cert sync from the following options:
- Managed: AppViewX will connect with the customer’s Azure account and discover certificates. These certificates will be added to the inventory. Users with the relevant permissions can then perform the required certificate-related actions.
- Monitored: AppViewX will connect with the customer’s Azure account and discover certificates. These certificates will be added to the inventory where the users will be allowed to only view the certificates.
- Ignored: AppViewX will connect with the customer’s Azure account but certificate discovery will be disabled.
- Click Save.
- Return to the Device :: Cloud page.
-
From the table of added devices displayed on the Device :: Cloud
page, from the Status column, click Check.
The status of the added device is displayed.
-
To view the certificates, go to
(Menu) > CERT+ > CERTIFICATE
INVENTORY and select the required certificate type.
Onboarding Certificates for Microsoft Azure Devices in AppViewX
- Via certificate discovery, for existing certificates
- Via certificate enrollment, for new certifcates
Discovering Certificates for Microsoft Azure Resources
-
Go to
(Menu) > CERT+ > CERTIFICATE
DISCOVERY > Discovery > Cloud Scan.
The Discovery : Cloud Scan : Add Discovery page is displayed. -
To initiate a cloud certificate discovery scan, enter/select the Discover
Details.
-
To filter the discovered certificates, enter/select the Discover
By details.
Table 7. Field descriptions for the Discover By section Field Description *Discovery From From the dropdown list, select Cloud (the source to discover a certificate from). *Vendor From the dropdown list, select Azure. Discovery Scope Select the Azure environment scope (range/boundary) within which the certificate discovery process will operate. - Azure Settings
Azure settings are configurable parameters that define the behavior of the resources within a subscription.
- Azure Subscriptions
Azure subscriptions are logical containers that consitute the Azure services and resources, identified based on a customer's agreement with Microsoft.
Enable Service Specific Discovery Note: This field is displayed only when Discovery Scope = Azure Subscriptions.To filter discovery results based on the services under each subscription mapped to a service, turn on the Enable Service Specific Discovery option.If this field is disabled, the discovery scope will include all the services within a subscription that is mapped to a setting.
*Selected Resources To search for a resource: - (Optional) In the Type your search and press
Enter field, enter a search keyword to filter
the list of resources.To make your search more specific:
- From the Type your search and press
Enter field, click
. - Enter/Select values for one or more of the
following parameters:
- Azure Settings
- Subscription ID
- Tenant ID
- Resource Type
- In the Condition field:
- To get search results that meet all your specified criteria, select AND.
- To get results that meet at least one (or more) of your specified criteria, select OR.
- From the Type your search and press
Enter field, click
- From the search results, select the checkbox corresponding to the required resource.
To add an existing resource to the list:- Click
. - From the Add Accounts dialog box, select the checkbox corresponding to the required resource(s).
- Click Add Selected.Note: The Add Selected button is enabled after at least one resource is selected.
To delete a resource from the list:- Select the checkbox corresponding to the resource you want to delete.
- From the Action field, click
.OR
Click
.Note: To delete multiple resources at once:- Select the checkboxes for the resources to be deleted.
- Click
.
Execute Batches Sequentially To execute the discovery operation on the specified batches sequentially, select this checkbox. *Interval Between Batches If Execute Batches Sequentially is selected, enter a interval duration (in minutes) in this field. The sequential execution of the batches is spaced according to the interval value entered hee. *: Mandatory fields - Azure Settings
-
In the Discovery Rules section, from the Associate Rule dropdown
list, select a rule that will be used to filter the discovered
certificates.
A setof filters is combined to create a rule, from the Rules menu. The selection of rules will apply respective filters on discovered certificates.
-
In the After Discover section, enter/select the following details:
Table 8. Field descriptions for the After Discover section Field Description *Move Certificate to Inventory with Status Select one from the following options: - Do not move: The newly discovered certificates and their objects will not be moved to the inventory.
- Managed: The newly discovered certificates and their objects will be moved to the inventory with the status set to Managed.
- Monitored: The newly discovered certificates and their objects will be moved to the inventory with the status set to Monitored.
Use Access Control Rule To apply the rule configured using Access Control, select this checkbox. Note: If this checkbox is enabled, the certificate group will be associated automatically by the rule in access control.*Certificate Group From the dropdown list, select a certificate group to which the discovered certificates will be associated. Based on the group association, a policy will also be applied to these certificates, which will help ascertain compliance or non-compliance.
*: Mandatory fields -
Click Discover/Schedule to trigger the on-demand/scheduled
discovery, respectively.
Once the certificates are discovered, you can view them in the certificate inventory.
To automate the certificate lifecycle management for the discovered certificates, you can enable auto regeneration of certificates, auto renewal of certificates, and auto push of certificates to endpoints.
Enrolling Certificates
Enrolling Server Certificates
-
Go to
(Menu) > CERT+ > CERTIFICATE
ACTION > Enroll Certificate >
Server
The Enroll Server Certificate page is displayed. - In the General Information section, from the dropdown list, select the required Assign Group.
-
Enter the CA Details.
Table 9. Field descriptions for the CA Details section Field Description *Certificate Authority From the dropdown list, select the certificate authority to request the certificate enrollment. Note: The IDnomic CA can be used for issuing certificates only in an on-prem deployment. Certificates issued through IDnomic CA can be renewed only if they are enrolled using a Registration Authority workflow.*Renew Automatically Note:To automatically renew this certificate:- If the Override feature is enabled for the certificate group selected from the Assign Group dropdown list, auto renew settings done in the enrollment page will be overwritten by the group level settings.
- If Regenerate Automatically has been enabled for the selected certificate group, the Renew Automatically field is not displayed here.
- Turn on the Renew
Automatically toggle.
The *Start Renewing field is displayed.
- In the Days Before Expiry field, specify how
many days prior to a certificate's expiry the
renewal process should start.
Valid range for number of days: 1 to 120
Note: The auto renew settings from the parent certificate will be transferred to the child certificate only if the toggle was enabled; they will not transfer if the certificate was renewed manually. After migration, these settings will be disabled for the parent certificate, so enable them manually if needed.*Regenerate Automatically To automatically regenerate this certificate: - Turn on the Regenerate Automatically
toggle.
The *Start Regenerating field is displayed.
- In the Days Before Expiry field, specify how
many days prior to a certificate's expiry the
regeneration process should start.
Valid range for number of days: 1 to 120
Note: This value can exceed the certificate's validity in case of short-lived certificates.
Note:- This feature can be enabled only for valid certificates (not for revoked/suspended and expired certificates).
- The auto regenerate settings from the parent certificate will be transferred to the child certificate only if the toggle was enabled; they will not transfer if the certificate was regenerated manually. After migration, these settings will be disabled for the parent certificate, so enable them manually if needed.
*CA Account From the dropdown list, select the CA account to which the certificate enrollment request will be submitted. Certificate Type From the dropdown list, select the required certificate type. *Division Note: This field is applicable only for Digicert CA.From the dropdown list, select the division with which the certificate will be enrolled.Certificate Profile Note: This field is displayed for only selected CAs. For the IDnomic CA, this field is displayed when only-CA setting is selected from the CA Account dropdown list.From the dropdown list, select the certificate profile with which the certificate must enroll.
*RA Workflow Note: This field is displayed when Certificate Authority = IDnomic and a CA+RA setting is selected from the CA Accounts dropdown list.From the dropdown list, select the RA workflow that will be used for certificate enrollment.For the details of a workflow, you can check them on your CA portal on IDnomic.
*Issuer Location Note: This field is applicable only for Google CA.From the dropdown list, select the issuer location associated with the CA account.
*Issuer Name Note: This field is applicable only for Google CA.From the dropdown list, select the issuer name for issuing the certificate.
*Connector Name Enter a friendly name for the CA connector. On saving this form, the name entered here will be displayed in the holistic view.
Description Note: Character limit: 2000 charactersEnter the description in this field.
*CSR Generation Note: This field is applicable for all CAs except Amazon.From the following options, select the required method for generating the CSR:
- AppViewX: Private key and CSR
will be created in AppViewX based on CSR parameters
given.Note: If auto regeneration has been enabled for this cerificate, AppViewX can be enforced as the default CSR generation source (irrespective of any selections made here) every time the certificate is regenerated. To do this, execute the following db script:
db.cert_metadata.insertOne({"_id":"CERT_AUTO_REGENERATE_DEFAULT_APPVIEWX_CSR", "flag":true}) - Upload CSR: You can upload a
file that contains the CSR details. This source file
will be used to populate the CSR parameters, which
will then be submitted to the CA.
- Under CSR Generation, select Upload
CSR.
The Please paste your CSR field is displayed.
- From the Please paste your CSR field, select Browse.
- Navigate to the location of your CSR file, and click Open.
- Click Upload.
- Under CSR Generation, select Upload
CSR.
- HSM: Note: This option is disabled/not displayed when Certificate Authority = Google, CSC Global, and DigiCert One.To generate the private key and the CSR, based on the CSR parameters given, in an HSM device:
- Under CSR Generation, select HSM.
-
Fields for gathering your HSM-related inputs are displayed.
Table 10. To generate the private key and the CSR, enter/select the following details: Field Description *Device Type From the dropdown list, from the following options, select the type of device on which the private key and the CSR will be generated: - HSM Devices
- ADC Devices
*Vendors Note: This field is applicable only when Device Type = ADC Devices.*Devices From the dropdown list, select the required HSM/ADC device. Note: This field is populated based on the Device Type and Vendors selected.*Key Handler Name Note: This field is applicable only when Device Type = HSM Devices.Enter the key handler name.*Key Reference Name Note: This field is applicable only when Device Type = ADC Devices.Enter the key reference name.
- End Point:
Note: This option is disabled when Certificate Authority = Google and CSC Global.
Table 11. To generate the private key and the CSR in the selected end point device, enter the following inputs: Field Description Category From the following options, select the ADC device category: - ADC
- Cloud
- Server
- Firewall
Vendor From the dropdown list, select the vendor for the end point device. Note: The dropdown list for this field is populated based on the Category selected.*Devices This field lists the end point devices present in your environment that belong to the above selected Category and Vendor. From the dropdown list, select the end point device on which you want to generate the private key and the CSR.
Tenant Note: This field is applicable only when Category = ADC.Enter the tenant ID.*Service name From the dropdown list, select the cloud service running on the selected cloud Devices. CSR Location Note: This field is applicable only when Category = Server.Partition Note: This field is applicable only when Category = Firewall.*CSR File Name Enter the name of the file that contains the CSR parameters. Note: Since the extension is already included in the field, ensure that you enter the file name without the file extension.Note: Starting v2023.1.0 FP2, for enrolling Apache server certificates, this field is labeled as CSR File Location.*Key File Name Enter the name of the file that contains the private key details. Note: Since the extension is already included in the field, ensure that you enter the file name without the file extension.Note: Starting v2023.1.0 FP2, for enrolling Apache server certificates, this field is labeled as Key File Location.*Certificate File Name Note: This field is displayed only when Category = Cloud.Enter the certificate file name.*Key vault Note: This field is displayed only when Category = Cloud, Vendor = Azure, and Service name = Key Vault (Azure).*Service Note: This field is displayed when Category = Server and Vendor = Microsoft Server.This dropdown list is populated based on the Device selected.From the options in the dropdown list, select the service.
*Exchange Server Note: This field is displayed when Category = Server and Vendor = Microsoft Server.From the dropdown list, select the name of the MS Exchange server for which the certificate is being enrolled.
*: Mandatory fields -
For the EJBCA certificate authority, enter/select the vendor
details.
Table 12. Field descriptions for the EJBCA Vendor Specific Details section Field Description * End Entity Profile Name From the dropdown list, select the end entity profile name. End entity user name Enter the name of the end user entity. * Issuer Common Name From the dropdown list, select the issuer common name. *Certificate Profile Name From the dropdown list, select the certificate profile name. *: Mandatory fields -
For the certificate being enrolled, enter the CSR Parameters.
Note: For DigiCert One, all CSR parameters that are assigned static values in the certificate profile will be auto-populated and disabled for editing.
Table 13. Field descriptions for the CSR Parameters Field Description Replace PSE File The Replace PSE File checkbox enables users to generate the CSR or private key in the Server. This checkbox is displayed only in the case described below: - Select the CSR Generation radio button as Endpoint.
- Select Category as Server, Vendor as ABAP or Web Dispatcher The Profiles dropdown is the only other field displayed below it and is populated with a list of .pse file names.
- Select the required Profile from the dropdown. Based on the values selected, the fields in the CSR Parameters section are auto-populated.
The Replace PSE File checkbox is disabled by default and the SAN details fields in CSR Parameters section are also disabled. Selecting the checkbox will make the SAN details enabled and allow for values to be updated.
*Common Name Enter the certificate's common name. The common name is one of the key values of Certificate Signing Request (CSR) to be present in the certificate. For example, <appviewx>.
Note: Constraints:- Character limit: 64 characters
- No special characters allowed except en dash (_) and hyphen (-).
Subject Alternative Name From the dropdown list, select the Subject Alternative Name category for the certificate being enrolled. In the corresponding field(s) displayed for the selection made, enter the required values.
Note:- Multiple values must be separated by a comma.
- After enrollment, the cumulative count of SANs is displayed in the certificate property pop-up window from the holistic view.
*Organization The organization name is one of the CSR parameters to be present in the certificate. This field will be auto-filled and editable based on the configuration in the selected group’s policy. Organization Unit Organization Unit name is one of the CSR parameters to be present in the certificate. This field will be auto-filled and editable based on the configuration in the selected group’s policy. Locality The locality name is one of the CSR parameters to be present in the certificate. This field will be auto-filled and editable based on the configuration in the selected group’s policy. State The state name is one of the CSR parameters to be present in the certificate. This field will be auto-filled and editable based on the configuration in the selected group’s policy. Country Country name is one of the CSR parameters to be present in the certificate. This field will be auto-filled and editable based on configuration. It must be a 2-letter country code (for example, US, and so on). Note: For renewal of the certificate being enrolled, country name is required.Email Address Enter a valid email address of the person responsible for maintaining the certificate. *Validity To specify the validity of the certificate being enrolled: - From the first dropdown list, select the number of days/months/years.
- From the second dropdown list, select the unit of
the duration from the following values:
Days/Months/Year.For example, if the validity of the certificate is 2 months:
- From the first dropdown list, select 2.
- From the second dropdown list, select Months.
Challenge Password Challenge password is one of the CSR parameters to be present in the certificate. Password must contain at least one alphabet (uppercase and lowercase), one number, and one special character. Confirm Password Re-enter the password entered in the Challenge Password field. *Hash Function The Hash function with which the CSR has to be signed. Any information specific to any CA or vendor has to be covered in the Note section. This field will be auto-filled and editable based on the configuration in the selected group’s policy. Note: For Certificate Authority = HydrantID, irrespective of the hash function selected, by default, the CA returns a certificate with SHA256. Therefore, admins must restrict users from creating a certificate with a hash function other than SHA256. To accomplish this, create policy with a single hash value (SHA256).*Key Type The key type is used while creating a private and public key pair. This field will be auto-filled and editable based on the configuration in the selected group’s policy. *Bit Length The bit length is used while creating a private and public key pair. This field will be auto-filled and editable based on the configuration in the selected group’s policy. *: Mandatory fields -
In the Attachments section, upload any additional documents that are
relevant to the enrollment of the certificate (for example, approval
emails).
Table 14. Field descriptions for the Attachments section Field Description Name Enter a name for the document. This need not be the actual name of the document; it can be an alternate name that will be used for reference only. Comments Enter any details relevant to the document being attached. Note: Character limit: 2000 charactersUpload File To upload an attachment: - Click Upload.
- Navigate to the location of the document to be uploaded.
- Select the document to be document and click
Open.
The selected document is uploaded and listed in the table displayed below these fields in the Attachments section.
Tip: If you've uploaded multiple attachments, use the Search field to find the required one.
*: Mandatory fields -
In the Certificate Attributes section, enter organization-specific
values, for the certificate attributes and custom attributes for the issuing CA,
that need to be mentioned along with the CSR.
These values will not be a part of the certificate but will be available in the AppViewX inventory. For example, cost center.Note: This additional information can be used to filter certificate details in the inventory.
-
Enter the relevant details in the Generic Fields. These are default
fields for maintaining the IP address and device information, if required.
Table 15. Field descriptions for the Generic Fields Field Description Device Name Enter the name of the device. Application IP Address Enter the IP address of the application. Tracking ID A free-form business alpha-numerical identifier, included in the audit logs, that may be used to correlate audit log entries (typically enrollment and revocation events) Certificate holder Email Note: This field is displayed only when a CA setting with a registration authority is selected for certificate enrollment.An email address that may be used to send notifications to certificate holder depending on the notification policies configured for the requested workflowFirst name Note: This field is displayed only when a CA setting with a registration authority is selected for certificate enrollment.First name (as a metadata) associated with the certificate to be enrolledLast name Note: This field is displayed only when a CA setting with a registration authority is selected for certificate enrollment.Last name (as a metadata) associated with the certificate to be enrolledOrganization Note: This field is displayed only when a CA setting with a registration authority is selected for certificate enrollment.Organization name (as a metadata) associated with the certificate to be enrolledComment Note: This field is displayed only when a CA setting with a registration authority is selected for certificate enrollment.Additional information (as a metadata) associated with the certificate to be enrolledUUID Note: This field is displayed only when a CA setting with a registration authority is selected for certificate enrollment.Universal Unique Identifier, or UUID, (as a metadata) associated with the certificate to be enrolled -
In the Vendor-Specific Details section, enter the
CA-specific details. Some of the CAs will expect additional details other than
CSR parameters as meta data for their operational purposes. Details common to
all CAs will be taken from the AppViewX user information of the logged in
user.
Table 16. Field descriptions for the common vendor specific details Field Description Certificate ID The Certificate ID is auto-populated based on the value entered in the Common Name field (in the CSR Parameters section). - The Certificate ID can be modified by the user.
- If the user edits the Certificate ID, any change to the Common Name will not reflect in the Certificate ID.
- If the user deletes the Certificate ID, the value of the Certificate ID field is set to the Common Name suffixed with the timestamp.
Table 17. Field descriptions for the CSC Global CA vendor specific details Field Description *Server Type From the dropdown list, select the server on which the application that requires the requested certificate is hosted. *Business Unit Enter the name of the business unit that is requesting the certificate. *Organization Contact Enter the email address of the contact in the organization requesting the certificate. *Phone Number Enter the phone number of the Organization Contact in the followung format: +<country code>-<phone number>. Note: For CSC Global, the phone number is not fetched from the AppViewX user information because of the difference in format.*Domain Control Validation Type From the following options in the dropdown list, select the method CSC Global will use for authentication before issuing a certificate: - EMAIL: CSC Global will send an approval/confirmation request to the registered email ID. Certificate issuance happens only after approval is received.
- CNAME: On requesting certificate issuance, CSC Global will provide you with a dynamic string. Add a CNAME record with this string to your DNS settings. CSC will issue the certificate requested only after validating this CNAME record.
Note: CSC Global will perform domain validation for all CLM actions.*: Mandatory fields Table 18. Field descriptions for the DigiCert CA vendor specific details Field Description *Server Type From the dropdown list, select the server on which the application that requires the requested certificate is hosted. *Payment Method From the dropdown list, select one from the following payment methods: - Bill To Account Balance: This
option allows you to pay for the DigiCert
certificate using the available balance in your
DigiCert account.Note: Ensure that the option to bill to account balance is enabled for the account and the account has sufficient balance.
- Bill To Default Credit Card:
This option will charge the cost of the DigiCert
certificate to the credit card set as the default
payment method in your DigiCert account.Note: Ensure that a credit card is configured as the default payment method for your account.
Additional Email Enter email addresses that will receive notifications for renewals, reissues, and duplicates for the specified order. Renewal Message Enter a custom message that will be sent with the renewal notifications. Notes Enter a custom note that will be sent with the order. *: Mandatory fields Table 19. Field descriptions for the DigiCert One CA vendor specific details Field Description Seat ID Enter the seat ID that will be assigned to the certificate being enrolled. Seat ID is a unique user-defined value assigned to identify an entity in the DigiCert One account. The seat ID for a certificate is used for certificate enrollment, renewal, and regeneration.Note: The Seat ID field is displayed only if the Allow Seat ID during enrollment option is selected for the CA account. In this case, the value entered in the Seat ID field is now a unique identifier for the certificate being enrolled. Otherwise, a common seat ID is assigned to all certificates enrolled for the selected CA accountTable 20. Field descriptions for the GlobalSign MSSL CA vendor specific details Field Description *Profile name A profile name is defined at the time of creating an account on the GlobalSign MSSL portal. AppViewX retrieves all your profile names from the GlobalSign MSSL portal and populates them in this dropdown list. From the dropdown list, select the profile name the enrolled certificate should be mapped to.
*: Mandatory fields Table 21. Field descriptions for the Hydrant ID CA vendor specific details Field Description Expiry Emails Enter a comma-separated list of email addresses that will receive the certificate expiry notification from HydrantID. Note: HydrantID CA does not accept updates to these email addresses during the renewal process.Table 22. Field descriptions for the Nexus CA vendor specific details Field Description Procedures The Procedures dropdown list will display only the procedures mapped to the server and the default procedure. From the dropdown list, select the required procedure. -
Click Add.
Once the details are added, you will be redirected to a page where the CSR and CA details are added as a connector. This page is called the holistic view and from here, any action on the certificate can be performed including provisioning the certificate to a server.
-
On the holistic view, click the Submit button to trigger
the request.
The submit action is triggered and the Submit dialog box is displayed.
-
Enter your comments in the text field and click Yes.
If the approval required option is enabled in the CA policy, the request is moved to the Approve and Implementation stages.
-
Click Approve to proceed.
The Approve dialog box is displayed.
-
Enter your comments in the text field.
Note: If the workflow request has to be approved automatically in the future, click the Schedule later button .
-
Click Yes.
Once the approval process is complete, the Implement option is displayed in the holistic view.
-
Click Implement.
The Implement dialog box is displayed.
-
Enter your comments in the text field.
If the workflow request has to be implemented automatically in the future, click Schedule later .
-
Click Yes.
CSR Submission to CA is in progress.Once the CSR submission is successful, the request state will be changed to Submit certificate - retrieval in progress state.
If the enrollment request is compliant with conditions defined and auto-approval enabled in the targeted CA, the certificate will be fetched in a few seconds.
If auto-approval disabled in the targeted CA, you will have to be logged into the CA and approve the request.
Once the certificate is issued successfully, the certificate will be retrieved into AppViewX. You can now push the enrolled certificate(s) to the required endpoint.
Important: For CSR generation at endpoint, for Category = Server and Vendor = LinuxServer, in the endpoint application connector created after the certificate is issued, the following fields (explained here) are auto-populated/enabled and cannot be modified:- Category
- Vendor
- Key Location
- Private key in Device
Enrolling Client Certificates
-
Go to
(Menu) > CERT+ > CERTIFICATE
ACTION > Enroll Certificate >
Client
The Enroll Client Certificate page is displayed. - In the General Information section, from the dropdown list, select the required Assign Group.
-
Enter/Select the CA Details.
Table 23. Field descriptions for the CA Details section Field Description *Certificate Authority Note: Depending on the CA selected, the rest of the fields will be displayed.From the dropdown list, select the required certificate authority (CA).Note: For enrolling certificates with policies using Google CA, consider the following points:Certificate Enrollment - Strict Policy- The Common Name will not be pre-filled from the policy.
- The following validation will be seen based on
strict policy guidelines.
- If the Common Name’s domain name is not present in the Allowed Domain Name list, an error validation will be shown upon saving the policy details.
Certificate Enrollment - Suggestive Policy- The Common Name will not be pre-filled from the policy
- The following validation will be seen based on
strict policy guidelines.
- If the Common Name’s domain name is not present in the Allowed Domain Name list, the non-compliant policy will be created.
- If the Common Name’s domain name is present in the Blocked Domain Name list, an error validation will be shown upon saving the policy details.
Note: For Certificate Authority = EJBCA, an additional set of fields, Vendor specific details is displayed after the CA Details section. Instructions on specifying the vendor specific details are covered in step 4.Note: The IDnomic CA can be used for issuing certificates only in an on-prem deployment. Certificates issued through IDnomic CA can be renewed only if they are enrolled using a Registration Authority workflow.*Renew Automatically Note:To automatically renew this certificate:- If the Override feature is enabled for the certificate group selected from the Assign Group dropdown list, auto renew settings done in the enrollment page will be overwritten by the group level settings.
- If Regenerate Automatically has been enabled for the selected certificate group, the Renew Automatically field is not displayed here.
- Turn on the Renew
Automatically toggle.
The *Start Renewing field is displayed.
- In the Days Before Expiry field, specify how
many days prior to a certificate's expiry the
renewal process should start.
Valid range for number of days: 1 to 120
Note: The auto renew settings from the parent certificate will be transferred to the child certificate only if the toggle was enabled; they will not transfer if the certificate was renewed manually. After migration, these settings will be disabled for the parent certificate, so enable them manually if needed.*Regenerate Automatically To automatically regenerate this certificate: - Turn on the Regenerate Automatically
toggle.
The *Start Regenerating field is displayed.
- In the Days Before Expiry field, specify how
many days prior to a certificate's expiry the
regeneration process should start.
Valid range for number of days: 1 to 120
Note: This value can exceed the certificate's validity in case of short-lived certificates.
Note:- This feature can be enabled only for valid certificates (not for revoked/suspended and expired certificates).
- The auto regenerate settings from the parent certificate will be transferred to the child certificate only if the toggle was enabled; they will not transfer if the certificate was regenerated manually. After migration, these settings will be disabled for the parent certificate, so enable them manually if needed.
*CA Account To which account the enrollment request to be submitted. Certificate Type Select the desired certificate type from the dropdown list. *Division Select the division to which the certificate must be enrolled. Note: This field will be shown only for Digicert CA.Certificate Profile Note: This field is applicable only for AppViewX CA and Google CA. For the IDnomic CA, this field is displayed when only-CA setting is selected from the CA Account dropdown list.From the dropdown list, select the profile with which the certificate must enroll.
*RA Workflow Note: This field is displayed when Certificate Authority = IDnomic and a CA+RA setting is selected from the CA Accounts dropdown list.From the dropdown list, select the RA workflow that will be used for certificate enrollment.For the details of a workflow, you can check them on your CA portal on IDnomic.
*Issuer Location Select the location of the issuer CA from the dropdown. Note: This is applicable only for Google CA.*Issuer Name Select the name of the issuer CA from the dropdown. Note: This is applicable only for Google CA.*Connector Name Enter the friendly name for Certificate Authority connector in this field which will be displayed in the holistic view on saving this form. Description Enter the description in this field. Note: Character limit: 2000 characters*CSR Generation Select the CSR generation option as required. Options are:
- UploadCSR
- Uploaded CSR will be taken as a source to populate
CSR parameters and submit to CA.
- Click the Browse button, and then the file.
- Click the Upload button to upload the selected file.
- On uploading CSR successfully, CSR parameters are automatically filled in the CSR section.
- HSM - Private key and CSR
will be created in the selected HSM device based on
CSR parameters given.
Field Description *Device Type Select the type of device as required. The possible options are:
- HSM Devices
- ADC Devices.
*Vendors Select the desired vendors from the dropdown list. The possible vendors are when device selected as HSM Devices:
- Fortanix
- PKCS11
The possible vendors are when device selected as ADC Devices:
- Safenet
- Thales
- Fortanix
*Devices Select the desired device from the dropdown list. Note:- By default, the None Selected option is enabled.
- When Device Type = ADC - User chooses from the list based on the vendors field selection.
*Key Handler Name Enter the desired handler name in the field. *Key Reference Name Enter the Key Reference Name. Note: This field appears only when Device Type = ADC Devices.
-
End Point - Private key and CSR will be created in the selected End Point device based on CSR parameters given.
Table 24. To generate the private key and the CSR in the selected end point device, enter/select the following inputs: Field Description Category From the following options, select the ADC device category: - ADC
- Cloud
- Server
- Firewall
Vendor From the dropdown list, select the vendor for the end point device. Note: The dropdown list for this field is populated based on the Category selected.*Devices This field lists the end point devices present in your environment that belong to the above selected Category and Vendor. From the dropdown list, select the end point device on which you want to generate the private key and the CSR.
Tenant Note: This field is applicable only when Category = ADC.Enter the tenant ID.*Service name From the dropdown list, select the cloud service running on the selected cloud Devices. CSR Location Note: This field is applicable only when Category = Server.Partition Note: This field is applicable only when Category = Firewall.*CSR File Name Enter the name of the file that contains the CSR parameters. Note: Since the extension is already included in the field, ensure that you enter the file name without the file extension.Note: Starting v2023.1.0 FP2, for enrolling Apache server certificates, this field is labeled as CSR File Location.*Key File Name Enter the name of the file that contains the private key details. Note: Since the extension is already included in the field, ensure that you enter the file name without the file extension.Note: Starting v2023.1.0 FP2, for enrolling Apache server certificates, this field is labeled as Key File Location.*Certificate File Name Note: This field is displayed only when Category = Cloud.Enter the certificate file name.*Key vault Note: This field is displayed only when Category = Cloud, Vendor = Azure, and Service name = Key Vault (Azure).*Service Note: This field is displayed when Category = Server and Vendor = Microsoft Server.This dropdown list is populated based on the Device selected.From the options in the dropdown list, select the service.
*Exchange Server Note: This field is displayed when Category = Server and Vendor = Microsoft Server.From the dropdown list, select the name of the MS Exchange server for which the certificate is being enrolled. - AppViewX - Private key and
CSR will be created in AppViewX based on CSR
parameters given.Note: If auto regeneration has been enabled for this cerificate, AppViewX can be enforced as the default CSR generation source (irrespective of any selections made here) every time the certificate is regenerated. To do this, execute the following db script:
db.cert_metadata.insertOne({"_id":"CERT_AUTO_REGENERATE_DEFAULT_APPVIEWX_CSR", "flag":true})
Note: For all CA types except Amazon, you have the option to generate the CSR.*: Mandatory fields -
For the EJBCA certificate authority, enter/select the vendor
details.
Table 25. Field descriptions for the EJBCA Vendor Specific Details section Field Description * End Entity Profile Name From the dropdown list, select the end entity profile name. End entity user name Enter the name of the end user entity. * Issuer Common Name From the dropdown list, select the issuer common name. *Certificate Profile Name From the dropdown list, select the certificate profile name. *: Mandatory fields -
Enter/Select the CSR Parameters.
Table 26. Field descriptions for the CSR Parameters section Field Description *Common Name The common name is one of the key values of Certificate Signing Request (CSR) to be present in the certificate. For example, <appviewx>. No special characters allowed except en dash (_) and hyphen (-).
Subject Alternative Name You can see the count of subject alternative names (SAN) available for a certificate in the CSR parameter section, inventory grid, and CA connector page. Select the subject alternative subject name from the dropdown list.
The possible options are,
- Select all
- DNS
- IP Address.
Note:- Multiple values must be separated by a comma.
- The cumulative count SANs appears in the certificate property pop-up window from the holistic view.
*Organization The organization name is one of the CSR parameters to be present in the certificate. This field will be auto-filled and editable based on the configuration in the selected group’s policy. Organization Unit Organization Unit name is one of the CSR parameters to be present in the certificate. This field will be auto-filled and editable based on the configuration in the selected group’s policy. Locality The locality name is one of the CSR parameters to be present in the certificate. This field will be auto-filled and editable based on the configuration in the selected group’s policy. State The state name is one of the CSR parameters to be present in the certificate. This field will be auto-filled and editable based on the configuration in the selected group’s policy. *Country Country name is one of the CSR parameters to be present in the certificate. This field will be auto-filled and editable based on configuration. It must be a 2-letter country code (for example, US, and so on). Email Address The email contact details of the person responsible for maintaining the certificate. Enter the valid e-mail address. *Validity Enter the number in this field and select the entered validity list to be in Days, Months, and Years from the dropdown list. Challenge Password Challenge password is one of the CSR parameters to be present in the certificate. Password must contain at least one alphabet (uppercase and lowercase), one number, and one special character. Confirm Password Reenter the same password to confirm that is entered in the Challenge Password field. *Hash Function The Hash function with which the CSR has to be signed. Any information specific to any CA or vendor has to be covered in the Note section. This field will be auto-filled and editable based on the configuration in the selected group’s policy. Note: For Certificate Authority = HydrantID, irrespective of the hash function selected, by default, the CA returns a certificate with SHA256. Therefore, admins must restrict users from creating a certificate with a hash function other than SHA256. To accomplish this, create policy with a single hash value (SHA256).*Key Type The key type is used while creating a private and public key pair. This field will be auto-filled and editable based on the configuration in the selected group’s policy. *Bit Length The bit length is used while creating a private and public key pair. This field will be auto-filled and editable based on the configuration in the selected group’s policy. *: Mandatory fields -
In the Attachments section, upload any additional documents that are
relevant to the enrollment of the certificate (for example, approval
emails).
Table 27. Field descriptions for the Attachments section Field Description Name Enter the alternate name for the document to be uploaded. Comments Enter the comments in this field. Note: Character limit: 2000 charactersUpload File Click the Upload button to select the file. - Other than the CSR fields, you can add organization-specific values along with CSR. These values will not be part of the certificate but will be available in the AppViewX inventory. For example, cost center. Inventory can be filtered based on these attributes as well. In the Certificate Attributes can be added under Administration > certificate attributes, it will be reflected on the enrollment page:
-
Enter the relevant details in the Generic Fields. These are default
fields for maintaining the IP address and device information, if required.
Table 28. Field descriptions for the Generic Fields Field Description Device Name Enter the name of the device. Application IP Address Enter the IP address of the application. Tracking ID A free-form business alpha-numerical identifier, included in the audit logs, that may be used to correlate audit logentries (typically enrollment and revocation events) Certificate holder Email This field is displayed only when a CA setting with a registration authority is selected for certificate enrollment. An email address that may be used to send notifications to certificate holder depending on the notification policies configured for the requested workflow First name This field is displayed only when a CA setting with a registration authority is selected for certificate enrollment. First name (as a metadata) associated with the certificate to be enrolled Last name This field is displayed only when a CA setting with a registration authority is selected for certificate enrollment. Last name (as a metadata) associated with the certificate to be enrolled Organization This field is displayed only when a CA setting with a registration authority is selected for certificate enrollment. Organization name (as a metadata) associated with the certificate to be enrolled Comment This field is displayed only when a CA setting with a registration authority is selected for certificate enrollment. Additional information (as a metadata) associated with the certificate to be enrolled UUID This field is displayed only when a CA setting with a registration authority is selected for certificate enrollment. Universal Unique Identifier, or UUID, (as a metadata) associated with the certificate to be enrolled -
In the Vendor-Specific Details section, enter the
CA-specific details. Some of the CAs will expect additional details other than
CSR parameters as meta data for their operational purposes. Details common to
all CAs will be taken from the AppViewX user information of the logged in
user.
Table 29. Field descriptions for the common vendor specific details Field Description Certificate ID The Certificate ID is auto-populated based on the value entered in the Common Name field (in the CSR Parameters section). - The Certificate ID can be modified by the user.
- If the user edits the Certificate ID, any change to the Common Name will not reflect in the Certificate ID.
- If the user deletes the Certificate ID, the value of the Certificate ID field is set to the Common Name suffixed with the timestamp.
Table 30. Field descriptions for the DigiCert CA vendor specific details Field Description *Server Type From the dropdown list, select the server on which the application that requires the requested certificate is hosted. *Payment Method From the dropdown list, select one from the following payment methods: - Bill To Account Balance: This
option allows you to pay for the DigiCert
certificate using the available balance in your
DigiCert account.Note: Ensure that the option to bill to account balance is enabled for the account and the account has sufficient balance.
- Bill To Default Credit Card:
This option will charge the cost of the DigiCert
certificate to the credit card set as the default
payment method in your DigiCert account.Note: Ensure that a credit card is configured as the default payment method for your account.
Additional Email Enter email addresses that will receive notifications for renewals, reissues, and duplicates for the specified order. Renewal Message Enter a custom message that will be sent with the renewal notifications. Notes Enter a custom note that will be sent with the order. *: Mandatory fields Table 31. Field descriptions for the Hydrant ID CA vendor specific details Field Description Expiry Emails Enter a comma-separated list of email addresses that will receive the certificate expiry notification from HydrantID. Note: HydrantID CA does not accept updates to these email addresses during the renewal process.Table 32. Field descriptions for the Nexus CA vendor specific details Field Description Procedures The Procedures dropdown list will display only the procedures mapped to the server and the default procedure. From the dropdown list, select the required procedure. -
Click Add.
Once the details are added, you will be redirected to a page where the CSR and CA details are added as a connector. This page is called the holistic view and from here, any action on the certificate can be performed including provisioning the certificate to a server.
-
On the holistic view, click the Submit button to trigger
the request.
The submit action is triggered and the Submit dialog box is displayed.
-
Enter your comments in the text field and click Yes.
If the approval required option is enabled in the CA policy, the request is moved to the Approve and Implementation stages.
-
Click Approve to proceed.
The Approve dialog box is displayed.
-
Enter your comments in the text field.
Note: If the workflow request has to be approved automatically in the future, click the Schedule later button .
-
Click Yes.
Once the approval process is completed, the Implement option is displayed in the holistic view.
-
Click Implement.
The Implement dialog box is displayed.
-
Enter your comments in the text field.
If the workflow request has to be implemented automatically in the future, click Schedule later .
-
Click Yes.
CSR Submission to CA is in progress.Once the CSR submission is successful, the request state will be changed to Submit certificate - retrieval in progress state.
If the enrollment request is compliant with conditions defined and auto-approval enabled in the targeted CA, the certificate will be fetched in a few seconds.
If auto-approval disabled in the targeted CA, you will have to be logged into the CA and approve the request.
Once the certificate is issued successfully, the certificate will be retrieved into AppViewX. You can now push the enrolled certificate(s) to the required endpoint.
Pushing Certificates to Microsoft Azure Application Gateway
Adding an Application Connector for Azure Application Gateway
-
On the certificate holistic view, click Add
Connector.
-
Enter/Select the General Information for the connector.
Table 33. Field descriptions for the connector General Information Field Description *Category From the dropdown list, select Cloud. *Vendor From the dropdown list, select Azure. Service Types From the dropdown list, select Application Gateway Target Profile Select the app service target profiles to which the certificate will be pushed. *Connector Name Enter a name for this connector, to be able to identify it later. Tip: AppViewX recommends naming connectors according to use cases so they are easily distinguishable.Description Enter any additional details you want to record for this connector. Based on the information entered here, the SSL templates section is populated with the list of available Microsoft Azure devices already onboarded in AppViewX. -
To select the device(s) to which the certificate will be pushed, under
SSL templates, from the list of Available Devices, for
the required device(s), click
.
The Selected devices list is updated automatically. -
Enter/Select the Certificate Details.
Table 34. Field descriptions for the Certificate Details Field Description *Certificate Type From the dropdown list, select the file type of the certificate to be pushed. *Certificate File Name Enter the file name of the certificate to be pushed. The file extension is auto-populated based on the Certificate Type selected. Certificate Push Type Select one from the following options: - Upload a Certificate to Gateway:
- Replace/Update existing Certificate in Gateway:
Certificate Location For the Azure Application Gateway, from the following options, select where the certificate will be stored after it is pushed: - Upload directly to Application Gateway: Upload certificates directly to the Application Gateway
- Choose from Azure Key Vault: Store certificates in Azure Key Vault and then reference them in the Application Gateway configuration.
Push Root and Intermediate Certificates To push the root and intermediate certificates, along with the end certificate, select this checkbox. For Azure, this field is enabled by default and is non-editable.
-
Enter/Select the Push Details.
Table 35. Field descriptions for the Push Details Field Description Pre - Push Script File Name Enter the file name of the pre-push script. Important: Read the pre and push script usage instructions here.Post - Push Script File Name Enter the file name of the post push script.Important: Read the pre and push script usage instructions here.Push Automatically To automatically push the certificate after it is renewed/reissued to the target system, enable this checkbox. Note: The auto push feature for a certificate works only if enabled for the certificate application connector as well the associated certificate group. To enable this feature at the certificate group level, refer the instructions here. -
Click Save.
The connector is displayed on the certificate holistic view.
Pushing a Server Certificate
-
Go to
(Menu) > CERT+ > CERTIFICATE ACTION >
Push to Device > Server.
The Server Certificate page is displayed. -
To push a certificate, under Common Name, double click the required
certificate.
The certificate topology view is displayed.
-
Click Push to Device. The Push to Device option will be shown if
the app connector is already added to the certificate otherwise add the app connector and
then proceed.
Note: The Push to Device option is displayed only after an app connector is added to certificate.The Confirmation dialog box is displayed.
- Enter your comments, if required, in the text field.
-
Click OK.
- The approval process is triggered. The current flow is based on the default policy of two-level approvals.
- A request ID and work order ID are generated automatically and the work order status is displayed alongside the connector in the certificate topology view.
- To approve the push request, from the certificate topology view, click Approve.
-
In the Confirmation dialog box:
- In the Manual Implementation field, to choose the mode of implementation, use the On/Off toggle.
- If you select Off, set the date and time to schedule the certificate push.
- Enter your comments in the text field and click Yes.
The work order status displayed beside the connector updates to Push-Review In Progress. - To implement the push request, from the certificate topology view, click Implement.
-
In the Confirmation dialog box:
- In the Manual Implementation field, to choose the mode of implementation, use the On/Off toggle.
- If you select Off, set the date and time to schedule the certificate push.
- Enter your comments in the text field and click Yes.
The push action is triggered. After the push action is completed, the status updates to Completed.Note:- Every time a certificate is pushed to a shared location in Palo Alto Firewall / Panorama,the user currently needs to log into the device and manually commit the changes. Moving forward, pushing a certificate to the shared location will automatically trigger the commit process. The push operation will only be marked as successful in AppViewX after the commit process successfully completes on the device.
- To refresh the certificate topology view, from the top-right corner of the screen,
click Refresh.

Pushing a Client Certificate
-
Go to
(Menu) > CERT+ > CERTIFICATE ACTION >
Push to Device > Client.
The Client Certificate page is displayed. -
To push a certificate, under Common Name, double click the required
certificate.
The certificate topology view is displayed.
-
Click Push to Device. The Push to Device option will be shown if
the app connector is already added to the certificate otherwise add the app connector and
then proceed.
Note: The Push to Device option is displayed only after an app connector is added to certificate.The Confirmation dialog box is displayed.
- Enter your comments, if required, in the text field.
-
Click OK.
- The approval process is triggered. The current flow is based on the default policy of two-level approvals.
- A request ID and work order ID are generated automatically and the work order status is displayed alongside the connector in the certificate topology view.
- To approve the push request, from the certificate topology view, click Approve.
-
In the Confirmation dialog box:
- In the Manual Implementation field, to choose the mode of implementation, use the On/Off toggle.
- If you select Off, set the date and time to schedule the certificate push.
- Enter your comments in the text field and click Yes.
The work order status displayed beside the connector updates to Push-Review In Progress. - To implement the push request, from the certificate topology view, click Implement.
-
In the Confirmation dialog box:
- In the Manual Implementation field, to choose the mode of implementation, use the On/Off toggle.
- If you select Off, set the date and time to schedule the certificate push.
- Enter your comments in the text field and click Yes.
The push action is triggered. After the push action is completed, the status updates to Completed.Note:- Every time a certificate is pushed to a shared location in Panorama,the user currently needs to log into the device and manually commit the changes. Moving forward, pushing a certificate to the shared location will automatically trigger the commit process. The push operation will only be marked as successful in AppViewX after the commit process successfully completes on the device.
- To refresh the certificate topology view, from the top-right corner of the screen,
click Refresh.

Enabling Auto Regeneration of Certificates
Enabling Auto Regeneration for a Certificate Group
You can enable and configure the auto regeneration feature at the certificate group level, which will apply to all certificates assigned to that group.
For details and instructions to enable auto regeneration at the certificate group level, click here.
Enabling Auto Regeneration at the Certificate Level
Enabling Auto Regenerate for Certificate Enrollment
For details and instructions to enable auto regeneration at the time of server certificate enrollment, click here.
Enabling Auto Regenerate for Discovered Certificates
-
Go to Menu > CERT+ >
Certificate Inventory >
Server.
The Server Certificate inventory is displayed.
-
From the inventory, for the certificate you want to enable auto push
for, click the common name.
The holistic view of the selected certificate is displayed.
-
For an existing CA connector for the certificate, hover over
.
-
From the menu displayed, click Edit.
The certificate details are displayed.
- Under CA Details, turn on the Regenerate Automatically toggle.
- In the Start Regenerating field, enter the number of days before expiration when the certificate should be regenerated.
-
Click Update.
The holistic view of the selected certificate is displayed.Note: For the auto regenerate process to take effect, set the auto push in the application connector. Refer to the Enabling Auto Push section.
Enabling Auto Push of Certificates
To enable auto push of certificates, you need to enable the corresponding option for the group to which the certificate in question belongs, as well as the connector created for that certificate.
-
To enable auto push for the certificate group:
-
To enable auto push for the certificate connector:
(Calendar widget) to select a date to start
the scheduled discovery.