Views:

Use this procedure to generate and record the HMAC secret required to establish secure GOverify connectivity. Generate a unique secret for each customer and environment connected to GOverify.

Protect this value: The generated HMAC secret is a credential. Do not place it in a support ticket, documentation, screenshot, chat message, or other unapproved location. Share it only with authorized people through an approved secure channel.

Before you begin

  • Use Windows PowerShell 5.1 or PowerShell 7 or newer.
  • If you are akoyaGO staff, make sure you can update the appropriate Constituent record in akoyaGO.
  • Confirm the customer and environment before generating the secret. Do not reuse a secret from another customer or environment.

Generate the HMAC secret

  1. Open Windows PowerShell 5.1 or PowerShell 7.

  2. Copy the complete block below, paste it into PowerShell, and press Enter:

    $bytes = New-Object byte[] 32
$rng = [System.Security.Cryptography.RandomNumberGenerator]::Create()

try {
    $rng.GetBytes($bytes)
    [Convert]::ToBase64String($bytes)
}
finally {
    $rng.Dispose()
}

  3. PowerShell displays one Base64 value. The value is randomly generated and will be different every time the command runs. 

    [generated Base64 value]

    Copy the entire value exactly as displayed. Include any = characters at the end, and do not add quotation marks or spaces.

The command creates 32 cryptographically strong random bytes and converts them to a Base64 string suitable for the HMAC secret used by the GOverify connection.

Record the secret

Outside IT vendor

  1. Confirm that the secret was generated for the correct customer and environment.
  2. Provide the complete value to the assigned akoyaGO Project Manager through an approved secure channel.
  3. Do not retain an unnecessary local copy after delivery has been confirmed.

akoyaGO staff

  1. Open the correct Constituent record in akoyaGO.
  2. Open Development details.
  3. Paste the complete value into the HMAC Secret field.
  4. Save the record.
  5. Remove the value from the clipboard and any temporary location after saving it.

Important handling requirements

  • Generate a new secret for every customer and environment.
  • Never reuse a production secret in a sandbox, test, or development environment.
  • Do not modify, shorten, or reformat the Base64 value.
  • Do not store the secret in source control, documentation, work notes, or screenshots.
  • If the secret is exposed, sent to the wrong person, or entered on the wrong record, treat it as compromised and coordinate generation and configuration of a replacement.

Troubleshooting

Problem Resolution
PowerShell does not display a value Copy and run the complete block again. Make sure the closing braces are included.
The saved secret is rejected Confirm that the entire Base64 value was copied, including trailing = characters. Remove quotation marks, spaces, and line breaks. If the original value cannot be confirmed securely, generate and configure a new secret.
The HMAC Secret field is unavailable or read-only Confirm that you opened the correct Constituent record and have permission to update Development details. Contact an akoyaGO administrator if access is still unavailable.
The value may have been exposed Do not continue using it. Notify the appropriate akoyaGO contact and coordinate generation and configuration of a replacement secret.

Technical reference: RandomNumberGenerator.GetBytes generates cryptographically strong random bytes, and Convert.ToBase64String converts those bytes to the value recorded in akoyaGO.

Keywords: GOverify, HMAC, HMAC Secret, connectivity, integration, configuration, Constituent, Development details, PowerShell

Keywords: GOverify, HMAC, HMAC secret, connectivity, integration, configuration, PowerShell, Constituent, Development details