Skip to content

Latest commit

 

History

History
273 lines (173 loc) · 15 KB

README.md

File metadata and controls

273 lines (173 loc) · 15 KB
Raw

Citrix Netscaler Universal Orchestrator Extension

Integration Status: production Release Issues GitHub Downloads (all assets, all releases)

Support · Installation · License · Related Integrations

Overview

The Citrix ADC Orchestrator remotely manages certificate objects on a Citrix ADC device. Since the ADC supports services including: Load Balancing, Authentication/Authorization/Auditing (AAA), and Gateways, this orchestrator can bind to any of these virtual servers when using unique virtual server names for each service.

Compatibility

This integration is compatible with Keyfactor Universal Orchestrator version 10.4 and later.

Support

The Citrix Netscaler Universal Orchestrator extension is supported by Keyfactor for Keyfactor customers. If you have a support issue, please open a support ticket with your Keyfactor representative. If you have a support issue, please open a support ticket via the Keyfactor Support Portal at https://support.keyfactor.com.

To report a problem or suggest a new feature, use the Issues tab. If you want to contribute actual bug fixes or proposed enhancements, use the Pull requests tab.

Requirements & Prerequisites

Before installing the Citrix Netscaler Universal Orchestrator extension, we recommend that you install kfutil. Kfutil is a command-line tool that simplifies the process of creating store types, installing extensions, and instantiating certificate stores in Keyfactor Command.

The Citrix ADC user needs permission to perform the following API calls:

API Endpoint Methods
/nitro/v1/config/login post
/nitro/v1/config/lbvserver get
/nitro/v1/config/sslcertkey get, update, add, delete
/nitro/v1/config/sslcertkey_service_binding get, update, add, delete
/nitro/v1/config/systemfile get, add, delete

Here is a sample policy with Min Permissions:

  • Action: Allow
  • Command Spec: (^stat\s+(cr|cs|lb|system|vpn))|(^(add|rm|show)\s+system\s+file\s+.)|(^\S+\s+ssl\s+.)|(^(show|stat|sync)\s+HA\s+.)|(^save\s+ns\s+config)|(^(switch|show)\s+ns\s+partition.)

Create the CitrixAdc Certificate Store Type

To use the Citrix Netscaler Universal Orchestrator extension, you must create the CitrixAdc Certificate Store Type. This only needs to happen once per Keyfactor Command instance.

  • Create CitrixAdc using kfutil:

    # CitrixAdc
kfutil store-types create CitrixAdc

  • Create CitrixAdc manually in the Command UI:

    Create CitrixAdc manually in the Command UI

    Create a store type called CitrixAdc with the attributes in the tables below:

    Basic Tab

    Attribute Value Description
    Name CitrixAdc Display name for the store type (may be customized)
    Short Name CitrixAdc Short display name for the store type
    Capability CitrixAdc Store type name orchestrator will register with. Check the box to allow entry of value
    Supports Add ✅ Checked Check the box. Indicates that the Store Type supports Management Add
    Supports Remove ✅ Checked Check the box. Indicates that the Store Type supports Management Remove
    Supports Discovery 🔲 Unchecked Indicates that the Store Type supports Discovery
    Supports Reenrollment 🔲 Unchecked Indicates that the Store Type supports Reenrollment
    Supports Create 🔲 Unchecked Indicates that the Store Type supports store creation
    Needs Server ✅ Checked Determines if a target server name is required when creating store
    Blueprint Allowed 🔲 Unchecked Determines if store type may be included in an Orchestrator blueprint
    Uses PowerShell 🔲 Unchecked Determines if underlying implementation is PowerShell
    Requires Store Password 🔲 Unchecked Enables users to optionally specify a store password when defining a Certificate Store.
    Supports Entry Password 🔲 Unchecked Determines if an individual entry within a store can have a password.

    The Basic tab should look like this:

    CitrixAdc Basic Tab

    Advanced Tab

    Attribute Value Description
    Supports Custom Alias Required Determines if an individual entry within a store can have a custom Alias.
    Private Key Handling Required This determines if Keyfactor can send the private key associated with a certificate to the store. Required because IIS certificates without private keys would be invalid.
    PFX Password Style Default 'Default' - PFX password is randomly generated, 'Custom' - PFX password may be specified when the enrollment job is created (Requires the Allow Custom Password application setting to be enabled.)

    The Advanced tab should look like this:

    CitrixAdc Advanced Tab

    Custom Fields Tab

    Custom fields operate at the certificate store level and are used to control how the orchestrator connects to the remote target server containing the certificate store to be managed. The following custom fields should be added to the store type:

    Name Display Name Description Type Default Value/Options Required
    linkToIssuer Link To Issuer Determines whether an attempt will be made to link the added certificate (via a Management-Add job) to its issuing CA certificate. Bool false 🔲 Unchecked

    The Custom Fields tab should look like this:

    CitrixAdc Custom Fields Tab

    Entry Parameters Tab

    Name Display Name Description Type Default Value Entry has a private key Adding an entry Removing an entry Reenrolling an entry
    virtualServerName Virtual Server Name When adding a certificate, this can be a single VServer name or a comma separated list of VServers to bind to Note: must match the number of Virtual SNI Cert values. String 🔲 Unchecked 🔲 Unchecked 🔲 Unchecked 🔲 Unchecked
    sniCert SNI Cert When adding a certificate, this can be a single boolean value (true/false) or a comma separated list of boolean values to determine whether the binding should use server name indication. Note: must match the number of Virtual Server Name values. String 🔲 Unchecked 🔲 Unchecked 🔲 Unchecked 🔲 Unchecked

    The Entry Parameters tab should look like this:

    CitrixAdc Entry Parameters Tab

Installation

  1. Download the latest Citrix Netscaler Universal Orchestrator extension from GitHub.

    Navigate to the Citrix Netscaler Universal Orchestrator extension GitHub version page. Refer to the compatibility matrix below to determine whether the net6.0 or net8.0 asset should be downloaded. Then, click the corresponding asset to download the zip archive.

    Universal Orchestrator Version Latest .NET version installed on the Universal Orchestrator server rollForward condition in Orchestrator.runtimeconfig.json citrix-adc-orchestrator .NET version to download
    Older than 11.0.0 net6.0
    Between 11.0.0 and 11.5.1 (inclusive) net6.0 net6.0
    Between 11.0.0 and 11.5.1 (inclusive) net8.0 Never net6.0
    Between 11.0.0 and 11.5.1 (inclusive) net8.0 LatestMajor net8.0
    11.6 and newer net8.0 net8.0

    Unzip the archive containing extension assemblies to a known location.

    Note If you don't see an asset with a corresponding .NET version, you should always assume that it was compiled for net6.0.

  2. Locate the Universal Orchestrator extensions directory.

    • Default on Windows - C:\Program Files\Keyfactor\Keyfactor Orchestrator\extensions
    • Default on Linux - /opt/keyfactor/orchestrator/extensions

  3. Create a new directory for the Citrix Netscaler Universal Orchestrator extension inside the extensions directory.

    Create a new directory called citrix-adc-orchestrator.

    The directory name does not need to match any names used elsewhere; it just has to be unique within the extensions directory.

  4. Copy the contents of the downloaded and unzipped assemblies from step 2 to the citrix-adc-orchestrator directory.

  5. Restart the Universal Orchestrator service.

    Refer to Starting/Restarting the Universal Orchestrator service.

The above installation steps can be supplimented by the official Command documentation.

Post Installation

An optional config.json configuration file has been provided in the extensions folder with a single setting - AutoSaveConfig. Setting this value to "Y" means successful changes made by a management job will automatically be saved to disk; no interaction with the Citrix ADC UI is necessary. Setting this value to "N" (or if the config entry or config file is missing) will keep these changes in memory only.

NOTE: Any changes in-process through the Citrix ADC UI will also be persisted to disk when a management job is performed and the AutoSaveConfig flag is set to 'Y'.

Defining Certificate Stores

  • Manually with the Command UI

    Create Certificate Stores manually in the UI

    1. Navigate to the Certificate Stores page in Keyfactor Command.

      Log into Keyfactor Command, toggle the Locations dropdown, and click Certificate Stores.

    2. Add a Certificate Store.

      Click the Add button to add a new Certificate Store. Use the table below to populate the Attributes in the Add form.

      Attribute Description
      Category Select "CitrixAdc" or the customized certificate store name from the previous step.
      Container Optional container to associate certificate store with.
      Client Machine The DNS or IP Address of the Citrix ADC Appliance.
      Store Path The path where certificate files are located on the Citrix ADC appliance. This value will likely be /nsconfig/ssl/
      Orchestrator Select an approved orchestrator capable of managing CitrixAdc certificates. Specifically, one with the CitrixAdc capability.
      linkToIssuer Determines whether an attempt will be made to link the added certificate (via a Management-Add job) to its issuing CA certificate.

  • Using kfutil

    Create Certificate Stores with kfutil

    1. Generate a CSV template for the CitrixAdc certificate store

      kfutil stores import generate-template --store-type-name CitrixAdc --outpath CitrixAdc.csv

    2. Populate the generated CSV file

      Open the CSV file, and reference the table below to populate parameters for each Attribute.

      Attribute Description
      Category Select "CitrixAdc" or the customized certificate store name from the previous step.
      Container Optional container to associate certificate store with.
      Client Machine The DNS or IP Address of the Citrix ADC Appliance.
      Store Path The path where certificate files are located on the Citrix ADC appliance. This value will likely be /nsconfig/ssl/
      Orchestrator Select an approved orchestrator capable of managing CitrixAdc certificates. Specifically, one with the CitrixAdc capability.
      linkToIssuer Determines whether an attempt will be made to link the added certificate (via a Management-Add job) to its issuing CA certificate.

    3. Import the CSV file to create the certificate stores

      kfutil stores import csv --store-type-name CitrixAdc --file CitrixAdc.csv

The content in this section can be supplimented by the official Command documentation.

Notes and Limitations

  • As of release 2.2.0, ONLY certificate objects (installed certificates) will be managed by the Citrix ADC Orchestrator Extension. Prior versions also managed certificate/key file combinations uploaded to the Citrix ADC device but not yet installed. This functionality has been removed due to issues attempting to match certificate and key files due to inconsistent file naming.

  • Direct PFX Binding Inventory: In NetScaler you can directly Bind a Pfx file to a Virtual Server. Keyfactor cannot inventory these because it does not have access to the password. The recommended way to Import PFX Files in NetScaler is descibed in this NetScaler Documentation

  • Removing Certs from Store: As defined in Test Cases 5 and 13 below, certificates that are bound to a server will not be removed. This was done to limit the possibility of bringing production servers down. Users are currently required to manually unbind the certificate from the server first and then remove via the Command and this orchestrator extension.

License

Apache License 2.0, see LICENSE.

Related Integrations

See all Keyfactor Universal Orchestrator extensions.