Merge pull request #376 from Venafi/cyberark-rebrand

Author: gdbarron

.gitignore

@@ -1,3 +1,4 @@
 .vscode
 .DS_Store
 Output
+.venv

README.md

@@ -3,7 +3,7 @@
   <img src="images/CyberArk_Logo_Horizontal_White_Tag-No-R.svg#only-dark" alt="CyberArk"/>
 </p>
 
-# VenafiPS - Automate your CyberArk Certificate Manager (Venafi TLS Protect) Self-Hosted and SaaS platforms!
+# VenafiPS - Automate your CyberArk Certificate Manager Self-Hosted and SaaS platforms!
 
 [![CI](https://github.com/Venafi/VenafiPS/actions/workflows/ci.yml/badge.svg)](https://github.com/Venafi/VenafiPS/actions/workflows/ci.yml)
 [![Deployment](https://github.com/Venafi/VenafiPS/actions/workflows/cd.yml/badge.svg?branch=main)](https://github.com/Venafi/VenafiPS/actions/workflows/cd.yml)
@@ -22,18 +22,26 @@ VenafiPS works on PowerShell v5.1 as well as cross-platform PowerShell on Window
 
 ## Install Module
 
+### Online
+
 VenafiPS is published to the PowerShell Gallery.  The most recent version is listed in the badge 'powershell gallery' above and can be viewed by clicking on it.  To install the module, you need to have PowerShell installed first.  On Windows, Windows PowerShell will already be installed, but is recommended to [install the latest version](https://learn.microsoft.com/en-us/powershell/scripting/install/installing-powershell-on-windows) of cross-platform PowerShell.  For [Linux](https://docs.microsoft.com/en-us/powershell/scripting/install/installing-powershell-core-on-linux?view=powershell-7) or [macOS](https://docs.microsoft.com/en-us/powershell/scripting/install/installing-powershell-core-on-macos?view=powershell-7), you will need to install PowerShell; follow those links for guidance.  Once PowerShell is installed, start a PowerShell prompt and execute `Install-Module -Name VenafiPS` which will install from the gallery.
 
 > :warning: If using an older operating system, eg. Windows Server 2016, and you receive errors downloading/installing nuget when attempting to install VenafiPS, your SSL/TLS version is most likely at the default and will not work.  Execute the following before installing the module,
 ``` powershell
 [System.Net.ServicePointManager]::SecurityProtocol = [System.Net.SecurityProtocolType]::Tls12
 ```
 
+### Offline
+
+If you are on a server without internet access or unable to reach/install from the PowerShell Gallery, a downloadable copy of the module is available as a fallback; this can be found at [Releases](https://github.com/Venafi/venafips/releases).  Download VenafiPS.zip from the latest release, extract, and execute the following from a PowerShell prompt, `Import-Module <unzipped-path>/VenafiPS.psd1 -Force`.
+
 ### Additional Modules
 
 - If running on Windows with PowerShell v5, multithreading is supported with [Microsoft.PowerShell.ThreadJob](https://github.com/PowerShell/ThreadJob), a Microsoft PowerShell module.  Install this via `Install-Module -Name Microsoft.PowerShell.ThreadJob` for increased performance on the functions that support it.  Version 2.1.0 has been tested.
 - There are a few SaaS functions which require Sodium encryption.  These functions require the `PSSodium` module be installed from the PowerShell Gallery via `Install-Module -Name PSSodium`; version 0.4.2 has been tested.  Optionally, you can provide `-Force` to the VenafiPS function for the module to be automatically installed.  Also for those functions, on Windows, the latest C++ runtime must be installed.
 
+As some users are on Self-Hosted and others on SaaS, it was decided to not include these modules by default.
+
 ## Usage
 
 As the module supports both Self-Hosted and SaaS, you will note different names for the functions.  Functions with `-Vdc` are for Self-Hosted only, `-Vc` are for SaaS only, and `-Venafi` are for both.  You can easily see the available commands for each platform with
@@ -127,13 +135,16 @@ Most of the same functionality from the above examples exist for SaaS as well.
 
 ## Token/Key Secret Storage
 
-To securely store and retrieve secrets, VenafiPS has added support for the [PowerShell SecretManagement module](https://github.com/PowerShell/SecretManagement).  This can be used to store your access tokens, refresh tokens, or vaas key.  To use this feature, a vault will need to be created.  You can use [SecretStore](https://github.com/PowerShell/SecretStore) provided by the PowerShell team or any other vault type.  All of this functionality has been added to `New-VenafiSession`.  To prepare your environment, execute the following:
+To securely store and retrieve secrets, VenafiPS has added support for the [PowerShell SecretManagement module](https://github.com/PowerShell/SecretManagement).  This can be used to store your access tokens, refresh tokens, or vaas key.  To use this feature, a vault will need to be created.  You can use [SecretStore](https://github.com/PowerShell/SecretStore) provided by the PowerShell team or any other vault type.  All of this functionality has been added to `New-VenafiSession`.
+
+To prepare your environment, execute the following:
+
 - `Install-Module Microsoft.PowerShell.SecretManagement`
 - `Install-Module Microsoft.PowerShell.SecretStore` or whichever vault you would like to use
 - `Register-SecretVault -Name VenafiPS -ModuleName Microsoft.PowerShell.SecretStore`.  If you are using a different vault type, replace the value for `-ModuleName`.
 - If using the vault Microsoft.PowerShell.SecretStore, execute `Set-SecretStoreConfiguration -Authentication None -Confirm:$false`.  Note, although the vault authentication is set to none, this just turns off the password required to access the vault, it does not mean your secrets are not encrypted.  This is required for automation purposes.  If using a different vault type, ensure you turn off any features which inhibit automation.
 - Check out the help for `New-VenafiSession` for the many ways you can store and retrieve secrets from the vault, but the easiest way to get started is:
-  - `New-VenafiSession -Server my.venafi.com -Credential $myCred -ClientId MyApp -Scope $scope -VaultRefreshTokenName mytoken`.  This will create a new token based session and store the refresh token in the vault.  The server and clientid will be stored with the refresh token as metadata.  Scope does not need to be stored as it is inherent in the token.
+  - `New-VenafiSession -Server cmsh.company.com -Credential $myCred -ClientId MyApp -Scope $scope -VaultRefreshTokenName mytoken`.  This will create a new token based session and store the refresh token in the vault.  The server and clientid will be stored with the refresh token as metadata.  Scope does not need to be stored as it is inherent in the token.
   - To create a new session going forward, `New-VenafiSession -VaultRefreshTokenName mytoken`.  This will retrieve the refresh token and associated metadata from the vault, retrieve a new access token based on that refresh token and create a new session.
 
 Note, extension vaults are registered to the current logged in user context, and will be available only to that user (unless also registered to other users).

docs/assets/css/branding.css

@@ -0,0 +1,68 @@
+/* ==========================
+    BRAND TOKENS
+========================== */
+:root {
+
+/* Company Colors */
+--cyberark-navy:              #082233; /*  30%   Bkg, Highlight Bkg, Workmark, Headlines, Subtitles, Body Copy, Eyebrow Copy, logo, Mark, infographics, iconography, badges, CTAs, section dividers */
+--cyberark-white:             #FFFFFF; /*  30%   Background  */
+--primary-white:              var(--cyberark-white); /*  Generic white  */
+--cyberark-electric-cyan:     #29B5E8; /*  13%   Highlight Bkg, Mark, Headline (on dark), Subtitles (on dark), Border accents, infographics, iconography, Badges, CTAs, Section dividers */
+--cyberark-bright-chartreuse: #D6F77A; /*  12%   Border accents, Headline Accents (on dark), Subtitle highlights (on Dark), infographics, Iconography, Badges */
+--cyberark-amethyst:          #8874FF; /*   5%   Infographics, Iconography, Quote Graphic device, Infographics, Eyebrow Underlines, Badges */
+--cyberark-sand:              #E8E8E3; /*   5%   Highlight backgrounds, Backgrounds, Section Divders */
+--cyberark-slate:             #5383A2; /*   5%   Headlines, subtitles, Callouts, Section Dividers */
+
+/* Foreground colors (light scheme) */
+--primary-color: var(--cyberark-navy);
+--secondary-color: var(--cyberark-electric-cyan);
+--third-color: var(--cyberark-bright-chartreuse);
+--fourth-color: var(--cyberark-amethyst);
+--fifth-color: var(--cyberark-slate);
+
+/* Background colors (light scheme) */
+--primary-background: var(--primary-white);
+--secondary-background:	var(--cyberark-sand);
+--third-background: color-mix(in oklch, var(--cyberark-electric-cyan), var(--primary-white) 95%);
+
+/* Define variants of core colors using math */
+--lighten-step: 20%;   /* Determines the step size for the color lightening math below */
+
+--primary-80: color-mix(in oklch, var(--primary-color), var(--primary-white) var(--lighten-step));
+--primary-60: color-mix(in oklch, var(--primary-color), var(--primary-white) calc(var(--lighten-step) * 2));
+--primary-40: color-mix(in oklch, var(--primary-color), var(--primary-white) calc(var(--lighten-step) * 3));
+--primary-20: color-mix(in oklch, var(--primary-color), var(--primary-white) calc(var(--lighten-step) * 4));
+
+--secondary-80: color-mix(in oklch, var(--secondary-color), var(--primary-white) var(--lighten-step));
+--secondary-60: color-mix(in oklch, var(--secondary-color), var(--primary-white) calc(var(--lighten-step) * 2));
+--secondary-40: color-mix(in oklch, var(--secondary-color), var(--primary-white) calc(var(--lighten-step) * 3));
+--secondary-20: color-mix(in oklch, var(--secondary-color), var(--primary-white) calc(var(--lighten-step) * 4));
+
+--third-80: color-mix(in oklch, var(--third-color), var(--primary-white) var(--lighten-step));
+--third-60: color-mix(in oklch, var(--third-color), var(--primary-white) calc(var(--lighten-step) * 2));
+--third-40: color-mix(in oklch, var(--third-color), var(--primary-white) calc(var(--lighten-step) * 3));
+--third-20: color-mix(in oklch, var(--third-color), var(--primary-white) calc(var(--lighten-step) * 4));
+
+--fourth-80: color-mix(in oklch, var(--fourth-color), var(--primary-white) var(--lighten-step));
+--fourth-60: color-mix(in oklch, var(--fourth-color), var(--primary-white) calc(var(--lighten-step) * 2));
+--fourth-40: color-mix(in oklch, var(--fourth-color), var(--primary-white) calc(var(--lighten-step) * 3));
+--fourth-20: color-mix(in oklch, var(--fourth-color), var(--primary-white) calc(var(--lighten-step) * 4));
+
+
+--fifth-80: color-mix(in oklch, var(--fifth-color), var(--primary-white) var(--lighten-step));
+--fifth-60: color-mix(in oklch, var(--fifth-color), var(--primary-white) calc(var(--lighten-step) * 2));
+--fifth-40: color-mix(in oklch, var(--fifth-color), var(--primary-white) calc(var(--lighten-step) * 3));
+--fifth-20: color-mix(in oklch, var(--fifth-color), var(--primary-white) calc(var(--lighten-step) * 4));
+
+/* CyberArk Docs colors - These aren't official, but I found them used on their docs site. */
+/* START - Don't use, as they are for reference */
+
+--alternate-background: #FCFCFC;
+--cyberark-menu-blue: #3165BD;
+--cyberark-menu-gray: #333333;
+--cyberark-link-blue: #047AD4;
+--cyberark-text-black: #000000;
+--cyberark-table-header-background: #F3F6F9;
+--cyberark-table-header-border: #DDD;
+/* END - Don't use  */
+}

docs/assets/css/components/fonts.css

@@ -0,0 +1,29 @@
+/*  ###  FONTS  *###  */
+@font-face {
+  font-family: "PublicSans";
+  src: url("/assets/css/fonts/PublicSans[wght].woff2") format("woff2");
+  font-weight: 100 900;
+  font-style: normal;
+  font-display: swap;
+}
+@font-face {
+  font-family: "PublicSans";
+  src: url("/assets/css/fonts/PublicSans-Italic[wght].woff2") format("woff2");
+  font-weight: 100 900;
+  font-style: italic;
+  font-display: swap;
+}
+@font-face {
+  font-family: "RobotoMono";
+  src: url("/assets/css/fonts/RobotoMono[wght].woff2") format("woff2");
+  font-weight: 100 700;
+  font-style: normal;
+  font-display: swap;
+}
+@font-face {
+  font-family: "RobotoMono";
+  src: url("/assets/css/fonts/RobotoMono-Italic[wght].woff2") format("woff2");
+  font-weight: 100 700;
+  font-style: italic;
+  font-display: swap;
+}