Skip to content

Commit

Permalink
Merge d88025b into 39c1e80
Browse files Browse the repository at this point in the history
  • Loading branch information
leefine02 authored Nov 12, 2024
2 parents 39c1e80 + d88025b commit 1425394
Show file tree
Hide file tree
Showing 12 changed files with 392 additions and 498 deletions.
3 changes: 2 additions & 1 deletion .github/workflows/keyfactor-bootstrap-workflow.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,10 @@ on:

jobs:
call-starter-workflow:
uses: keyfactor/actions/.github/workflows/starter.yml@v2
uses: keyfactor/actions/.github/workflows/starter.yml@3.1.2
secrets:
token: ${{ secrets.V2BUILDTOKEN}}
APPROVE_README_PUSH: ${{ secrets.APPROVE_README_PUSH}}
gpg_key: ${{ secrets.KF_GPG_PRIVATE_KEY }}
gpg_pass: ${{ secrets.KF_GPG_PASSPHRASE }}
scan_token: ${{ secrets.SAST_TOKEN }}
20 changes: 6 additions & 14 deletions F5BigIQ/F5BigIQ.csproj
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
<Project Sdk="Microsoft.NET.Sdk">

<PropertyGroup>
<AppendTargetFrameworkToOutputPath>false</AppendTargetFrameworkToOutputPath>
<TargetFramework>net6.0</TargetFramework>
<AppendTargetFrameworkToOutputPath>true</AppendTargetFrameworkToOutputPath>
<TargetFrameworks>net6.0;net8.0</TargetFrameworks>
<CopyLocalLockFileAssemblies>true</CopyLocalLockFileAssemblies>
<ImplicitUsings>disable</ImplicitUsings>
</PropertyGroup>

<ItemGroup>
Expand All @@ -12,19 +13,10 @@
<PackageReference Include="Keyfactor.PKI" Version="5.5.0" />
<PackageReference Include="RestSharp" Version="110.2.0" />
<PackageReference Include="SSH.NET" Version="2024.0.0" />
</ItemGroup>

<ItemGroup>
<Reference Include="Renci.SshNet">
<HintPath>External References\Renci.SshNet.dll</HintPath>
</Reference>
<Reference Include="SshNet.Security.Cryptography">
<HintPath>External References\SshNet.Security.Cryptography.dll</HintPath>
</Reference>
<None Update="manifest.json">
<CopyToOutputDirectory>Always</CopyToOutputDirectory>
</None>
</ItemGroup>

<Target Name="PostBuild" AfterTargets="PostBuildEvent">
<Exec Command="echo F | xcopy &quot;$(ProjectDir)manifest.json&quot; &quot;$(TargetDir)\manifest.json&quot; /Y" />
</Target>

</Project>
387 changes: 212 additions & 175 deletions README.md

Large diffs are not rendered by default.

23 changes: 23 additions & 0 deletions docsource/content.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
## Overview

The F5 Big IQ Orchestrator Extension supports the following use cases:

- Inventories an existing F5 Big IQ device to import SSL certificates into Keyfactor Command for management
- Add an existing or newly enrolled certificate and private key to an existing F5 Big IQ device not already on that device.
- Remove a certificate and private key from an existing F5 Big IQ device.
- Add an existing or newly enrolled certificate and private key to an existing F5 Big IQ device already on that device. Optionally (based on the DeployCertificateOnRenewal setting on the certificate store), the newly renewed/replaced certificate will be deployed to any linked F5 Big IP device.
- Reenrollment (On Device Key Generation) of a new or existing certificate on the F5 Big IQ device. In this use case, the key pair and CSR will be created on the F5 Big IQ device, Keyfactor Command will enroll the certificate, and the certificate will then be installed on the device. If the DeployCertificateOnRenewal option is set, the certificate will be deployed to any linked F5 Big IP devices.

Use cases NOT supported by the F5 Big IQ Orchestrator Extension:

- Creating new binding relationships between F5 Big IQ and any linked F5 Big IP devices.
- Storing binding relationships in Keyfactor Command during Inventory.


## Requirements

When creating a Keyfactor Command Certificate Store, you will be asked to enter server credentials. These credentials will serve two purposes:
1. They will be used to authenticate to the F5 Big IQ instance when accessing API endpoints. Please make sure these credentials have Admin authority on F5 Big IQ.
2. When Inventorying and Adding/Replacing certificates it will be necessary for certificate files to be transferred to and from the F5 device. The F5 Big IQ Orchestrator Extension uses SCP (Secure Copy Protocol) to perform these functions. Please make sure your F5 Big IQ device is set up to allow SCP to transfer files *to* /var/config/rest/downloads (a reserved F5 Big IQ folder used for file transfers) and *from* /var/config/rest/fileobject (the certificate file location path) and all subfolders. Other configuration tasks may be necessary in your environment to enable this feature.


1 change: 1 addition & 0 deletions docsource/f5-bigiq.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
## Overview
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
285 changes: 148 additions & 137 deletions integration-manifest.json
Original file line number Diff line number Diff line change
@@ -1,137 +1,148 @@
{
"$schema": "https://keyfactor.github.io/integration-manifest-schema.json",
"integration_type": "orchestrator",
"name": "F5 BigIQ",
"status": "production",
"support_level": "kf-supported",
"description": "The F5 Big IQ Orchestrator allows for the remote management of F5 Big IQ certificate stores. Inventory, Management, and Reenrollment functions are supported.",
"link_github": true,
"update_catalog": true,
"release_dir": "F5BigIQ/bin/Release",
"about": {
"orchestrator": {
"UOFramework": "10.4",
"keyfactor_platform_version": "10.3",
"pam_support": true,
"win": {
"supportsCreateStore": false,
"supportsDiscovery": false,
"supportsManagementAdd": true,
"supportsManagementRemove": true,
"supportsReenrollment": true,
"supportsInventory": true
},
"linux": {
"supportsCreateStore": false,
"supportsDiscovery": false,
"supportsManagementAdd": true,
"supportsManagementRemove": true,
"supportsReenrollment": true,
"supportsInventory": true
},
"store_types": [
{
"Name": "F5 Big IQ",
"ShortName": "F5-BigIQ",
"Capability": "F5-BigIQ",
"LocalStore": false,
"SupportedOperations": {
"Add": true,
"Create": false,
"Discovery": false,
"Enrollment": true,
"Remove": true
},
"Properties": [
{
"Name": "DeployCertificateOnRenewal",
"DisplayName": "Deploy Certificate to Linked Big IP on Renewal",
"Type": "Bool",
"DependsOn": "",
"DefaultValue": "false",
"Required": false
},
{
"Name": "IgnoreSSLWarning",
"DisplayName": "Ignore SSL Warning",
"Type": "Bool",
"DependsOn": "",
"DefaultValue": "false",
"Required": false
},
{
"Name": "UseTokenAuth",
"DisplayName": "Use Token Authentication",
"Type": "Bool",
"DependsOn": "",
"DefaultValue": "false",
"Required": false
},
{
"Name": "LoginProviderName",
"DisplayName": "Authentication Provider Name",
"Type": "String",
"DependsOn": "UseTokenAuth",
"DefaultValue": "",
"Required": false
}
],
"EntryParameters": [
{
"Name": "Alias",
"DisplayName": "Alias (Reenrollment only)",
"Type": "String",
"RequiredWhen": {
"HasPrivateKey": false,
"OnAdd": false,
"OnRemove": false,
"OnReenrollment": true
},
"DependsOn": "",
"DefaultValue": "",
"Options": ""
},
{
"Name": "Overwrite",
"DisplayName": "Overwrite (Reenrollment only)",
"Type": "Bool",
"RequiredWhen": {
"HasPrivateKey": false,
"OnAdd": false,
"OnRemove": false,
"OnReenrollment": true
},
"DependsOn": "",
"DefaultValue": "False",
"Options": ""
},
{
"Name": "SANs",
"DisplayName": "SANs (Reenrollment only)",
"Type": "String",
"RequiredWhen": {
"HasPrivateKey": false,
"OnAdd": false,
"OnRemove": false,
"OnReenrollment": false
},
"DependsOn": "",
"DefaultValue": "",
"Options": ""
}
],
"PasswordOptions": {
"EntrySupported": false,
"StoreRequired": false,
"Style": "Default"
},
"PrivateKeyAllowed": "Required",
"ServerRequired": true,
"PowerShell": false,
"BlueprintAllowed": true,
"CustomAliasAllowed": "Required"
}
]
}
}
}
{
"$schema": "https://keyfactor.github.io/integration-manifest-schema.json",
"integration_type": "orchestrator",
"name": "F5 BigIQ",
"status": "production",
"support_level": "kf-supported",
"description": "The F5 Big IQ Orchestrator allows for the remote management of F5 Big IQ certificate stores. Inventory, Management, and Reenrollment functions are supported.",
"link_github": true,
"update_catalog": true,
"release_project": "F5BigIQ/F5BigIQ.csproj",
"release_dir": "F5BigIQ/bin/Release",
"about": {
"orchestrator": {
"UOFramework": "10.4",
"keyfactor_platform_version": "10.3",
"pam_support": true,
"store_types": [
{
"Name": "F5 Big IQ",
"ShortName": "F5-BigIQ",
"Capability": "F5-BigIQ",
"PrivateKeyAllowed": "Required",
"ServerRequired": true,
"PowerShell": false,
"BlueprintAllowed": true,
"CustomAliasAllowed": "Required",
"SupportedOperations": {
"Add": true,
"Create": false,
"Discovery": false,
"Enrollment": true,
"Remove": true
},
"PasswordOptions": {
"EntrySupported": false,
"StoreRequired": false,
"Style": "Default"
},
"Properties": [
{
"Name": "DeployCertificateOnRenewal",
"DisplayName": "Deploy Certificate to Linked Big IP on Renewal",
"Type": "Bool",
"DependsOn": "",
"DefaultValue": "false",
"Required": false,
"Description": "This optional setting determines whether renewed certificates (Management-Add jobs with Overwrite selected) will be deployed to all linked Big IP devices. Linked devices are determined by looking at all of the client-ssl profiles that reference the renewed certificate that have an associated virtual server linked to a Big IP device. An immediate deployment is then scheduled within F5 Big IQ for each linked Big IP device."
},
{
"Name": "IgnoreSSLWarning",
"DisplayName": "Ignore SSL Warning",
"Type": "Bool",
"DependsOn": "",
"DefaultValue": "false",
"Required": false,
"Description": "If you use a self signed certificate for the F5 Big IQ portal, you will need to add this optional Custom Field and set the value to True on the managed certificate store."
},
{
"Name": "UseTokenAuth",
"DisplayName": "Use Token Authentication",
"Type": "Bool",
"DependsOn": "",
"DefaultValue": "false",
"Required": false,
"Description": "If you prefer to use F5 Big IQ's Token Authentication to authenticate F5 Big IQ API calls, you will need to add this optional Custom Field and set the value to True on the managed certificate store. If set to True for the store, the userid/password credentials you set for the certificate store will be used once to receive a token. This token is then used for all subsequent API calls for the duration of the job. If this option does not exist or is set to False, the userid/password credentials you set for the certificate store will be used for all API calls."
},
{
"Name": "LoginProviderName",
"DisplayName": "Authentication Provider Name",
"Type": "String",
"DependsOn": "UseTokenAuth",
"DefaultValue": "",
"Required": false,
"Description": "If Use Token Authentication is selected, you may optionally add a value for the authentication provider F5 Big IQ will use to retrieve the auth token. If you choose not to add this field or leave it blank on the certificate store (with no default value set), the default of \"TMOS\" will be used."
},
{
"Name": "ServerUsername",
"DisplayName": "Server Username",
"Type": "Secret",
"DependsOn": "",
"DefaultValue": "",
"IsPAMEligible": true,
"Required": false,
"Description": "Login credential for the F5 Big IQ device. MUST be an Admin account."
},
{
"Name": "ServerPassword",
"DisplayName": "Server Password",
"Type": "Secret",
"DependsOn": "",
"DefaultValue": "",
"IsPAMEligible": true,
"Required": false,
"Description": "Login password for the F5 Big IQ device."
}
],
"EntryParameters": [
{
"Name": "Alias",
"DisplayName": "Alias (Reenrollment only)",
"Type": "String",
"RequiredWhen": {
"HasPrivateKey": false,
"OnAdd": false,
"OnRemove": false,
"OnReenrollment": true
},
"DependsOn": "",
"DefaultValue": "",
"Options": "",
"Description": "The name F5 Big IQ uses to identify the certificate"
},
{
"Name": "Overwrite",
"DisplayName": "Overwrite (Reenrollment only)",
"Type": "Bool",
"RequiredWhen": {
"HasPrivateKey": false,
"OnAdd": false,
"OnRemove": false,
"OnReenrollment": true
},
"DependsOn": "",
"DefaultValue": "False",
"Options": "",
"Description": "Allow overwriting an existing certificate when reenrolling?"
},
{
"Name": "SANs",
"DisplayName": "SANs (Reenrollment only)",
"Type": "String",
"RequiredWhen": {
"HasPrivateKey": false,
"OnAdd": false,
"OnRemove": false,
"OnReenrollment": false
},
"DependsOn": "",
"DefaultValue": "",
"Options": "",
"Description": "External SANs for the requested certificate. Each SAN must be prefixed with the type (DNS: or IP:) and multiple SANs must be delimitted by an ampersand (&). Example: DNS:server.domain.com&IP:127.0.0.1&DNS:server2.domain.com. This is an optional field."
}
]
}
]
}
}
}
5 changes: 0 additions & 5 deletions readme-src/readme-pam-support.md

This file was deleted.

Loading

0 comments on commit 1425394

Please sign in to comment.