< Back

Get-KeyAuthorization

Sat Jan 18, 2020 7:31 pm

NAME Get-KeyAuthorization



SYNOPSIS

Calculate a key authorization string for a challenge token.





SYNTAX

Get-KeyAuthorization [-Token] <String> [[-Account] <Object>] [-ForDNS] [<CommonParameters>]





DESCRIPTION

A key authorization is a string that expresses a domain holder's authorization for a specified key to satisfy a

specified challenge, by concatenating the token for the challenge with a key fingerprint.





PARAMETERS

-Token <String>

The token string for an ACME challenge.



Required? true

Position? 1

Default value

Accept pipeline input? true (ByValue)

Accept wildcard characters? false



-Account <Object>

The ACME account associated with the challenge.



Required? false

Position? 2

Default value

Accept pipeline input? false

Accept wildcard characters? false



-ForDNS [<SwitchParameter>]

Enable this switch if you're using the key authorization value for the 'dns-01' challenge type. It will do a

few additional manipulation steps on the value that are required for a DNS TXT record.



Required? false

Position? named

Default value False

Accept pipeline input? false

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).



INPUTS



OUTPUTS

System.String





-------------------------- EXAMPLE 1 --------------------------



PS C:\\>Get-KeyAuthorization 'XxXxXxXxXxXx'



Get the key authorization for the specified token using the current account.









-------------------------- EXAMPLE 2 --------------------------



PS C:\\>(Get-PAOrder | Get-PAAuthorizations).DNS01Token | Get-KeyAuthorization



Get all key authorizations for the DNS challenges in the current order using the current account.











RELATED LINKS

Project: https://github.com/rmbolger/Posh-ACME

Get-PAAuthorizations

Submit-ChallengeValidation