AzureSecrets Component
Properties Methods Events Configuration Settings Errors
The AzureSecrets component makes it easy to interact with secrets in Azure Key Vaults.
Syntax
TickAzureSecrets
Remarks
The AzureSecrets component provides an easy-to-use interface for the secret-related functionality of the Azure Key Vault service. Azure Key Vault allows you to work with a few different kinds of resources, one of which is secrets (e.g., passwords, symmetric keys, etc.). This component helps you to create and manage said secrets. To work with asymmetric key pairs instead, refer to the AzureKeys component.
To begin, register for an Azure account and create one or more Key Vaults via the Azure Portal. Set the Vault property to the name of the vault you wish to work with.
This component supports authentication via OAuth 2.0. First, perform OAuth authentication using the OAuth component or a separate process. Once complete you should have an authorization string which looks like:
Bearer ya29.AHES6ZSZEJzATdZYjeihDn5W-VrXSsxEZu5p0pclxGdKKQAssign this value to the Authorization property before attempting any operations. Consult the documentation for the service for more information about supported scope values and more details on OAuth authentication.
Using the Component
Secrets can be created using the CreateSecret method. A secret's name must be set at the time of creation, and cannot be changed later. The secret's value and, optionally, content type must also be set, but can be changed at any time. To change a secret's value, create a new version of it using the CreateSecret method (which will always create a new version if a secret with the specified name already exists); to change a secret's content-type, use the UpdateSecret method.
To retrieve a secret and its information, use the GetSecret method.
When a secret will no long be used, it can be deleted using the DeleteSecret method. However, the secret will only be soft-deleted; by default, Azure will permanently delete it after the waiting period configured for the vault. During this waiting period, the soft-deleted secret may be recovered using RecoverSecret, or permanently deleted using PurgeSecret (assuming the currently-authenticated user has the permissions to do so).
// Create a secret.
azuresecrets.SecretData = "Test123";
azuresecrets.CreateSecret("mysecret", "text/plain");
// Download the secret value to a local file.
azuresecrets.LocalFile = "C:\temp\secret.txt";
azuresecrets.GetSecret("mysecret");
// Create a new version of the secret.
azuresecrets.SecretData = "Cats456";
azuresecrets.CreateSecret("mysecret", "text/plain");
// ... Some time later, when the secret is no longer needed ...
azuresecrets.DeleteSecret("mysecret");
// At this point, the secret is only soft-deleted. It could be recovered...
azuresecrets.RecoverSecret("mysecret");
// ...or permanently deleted.
azuresecrets.PurgeSecret("mysecret");
To list secrets, use the ListSecrets method. This method is also used to list soft-deleted secrets if the GetDeleted configuration setting has been enabled first. To list a secret's versions, use the ListVersions method. (You cannot list a deleted secret's versions.)
// If there are many secrets to list, there may be multiple pages of results. This will
// cause all pages of results to be accumulated into the Secrets collection property.
do {
azuresecrets.ListSecrets();
} while (!string.IsNullOrEmpty(azuresecrets.SecretMarker));
// A similar thing applies to secret versions as well.
do {
azuresecrets.ListVersions("mysecret");
} while (!string.IsNullOrEmpty(azuresecrets.VersionMarker));
The component also supports a variety of other functionality, including:
- Enabling and disabling secrets with SetSecretEnabled.
- Tagging support using AddTag and the Tag* properties.
- Secure secret backup and restoration using BackupSecret and RestoreSecret.
- And more!
Property List
The following is the full list of the properties of the component with short descriptions. Click on the links for further details.
Authorization | OAuth 2.0 Authorization Token. |
EncodeData | Whether to automatically base64-encode and -decode secret data. |
Firewall | A set of properties related to firewall access. |
Idle | The current status of the component. |
LocalFile | The local file to write data to, or whose data should be sent. |
LocalHost | The name of the local host or user-assigned IP interface through which connections are initiated or accepted. |
OtherHeaders | Other headers as determined by the user (optional). |
Overwrite | Whether the local file should be overwritten if necessary. |
ParsedHeaders | Collection of headers returned from the last request. |
Proxy | A set of properties related to proxy access. |
QueryParams | Additional query parameters to be included in the request. |
SecretData | The secret data that was retrieved, or that should be sent. |
SecretMarker | A marker indicating what page of secrets to return next. |
Secrets | A collection of secrets. |
SSLAcceptServerCertEncoded | The certificate (PEM/base64 encoded). |
SSLCertEncoded | The certificate (PEM/base64 encoded). |
SSLCertStore | The name of the certificate store for the client certificate. |
SSLCertStorePassword | If the certificate store is of a type that requires a password, this property is used to specify that password in order to open the certificate store. |
SSLCertStoreType | The type of certificate store for this certificate. |
SSLCertSubject | The subject of the certificate used for client authentication. |
SSLServerCertEncoded | The certificate (PEM/base64 encoded). |
Tags | A collection of tags. |
Timeout | A timeout for the component. |
Vault | Selects a vault for the component to interact with. |
VersionMarker | A marker indicating what page of secret versions to return next. |
Method List
The following is the full list of the methods of the component with short descriptions. Click on the links for further details.
AddQueryParam | Adds a query parameter to the QueryParams properties. |
AddTag | Adds an item to the Tags properties. |
BackupSecret | Backs up a secret. |
Config | Sets or retrieves a configuration setting. |
CreateSecret | Creates a new secret. |
DeleteSecret | Deletes a secret. |
DoEvents | Processes events from the internal message queue. |
GetSecret | Gets a secret's value and information. |
ListSecrets | Lists the secrets in the currently-selected vault. |
ListVersions | Lists versions of a secret. |
PurgeSecret | Permanently deletes a soft-deleted secret. |
RecoverSecret | Recovers a soft-deleted secret. |
Reset | Resets the component to its initial state. |
RestoreSecret | Restores a previously backed-up secret to the vault. |
SetInputStream | Sets the stream whose data should be sent. |
SetOutputStream | Sets the stream to which received data should be written. |
SetSecretEnabled | Enables or disables a secret. |
UpdateSecret | Updates a secret's information. |
Event List
The following is the full list of the events fired by the component with short descriptions. Click on the links for further details.
EndTransfer | Fired when a document finishes transferring. |
Error | Information about errors during data delivery. |
Header | Fired every time a header line comes in. |
Log | Fires once for each log message. |
SecretList | Fires once for each secret when listing secrets. |
SSLServerAuthentication | Fired after the server presents its certificate to the client. |
SSLStatus | Shows the progress of the secure connection. |
StartTransfer | Fired when a document starts transferring (after the headers). |
TagList | Fires once for each tag returned when a secret is retrieved. |
Transfer | Fired while a document transfers (delivers document). |
Configuration Settings
The following is a list of configuration settings for the component with short descriptions. Click on the links for further details.
AccumulatePages | Whether the component should accumulate subsequent pages of results when listing them. |
APIVersion | The Azure Key Vault API version that the component conforms to. |
CloseInputStreamAfterProcessing | Whether the specified input stream should be closed after data is read from it. |
CloseOutputStreamAfterProcessing | Whether the specified output stream should be closed after data is written to it. |
CreateSecretEnabled | Whether new secrets should be created in an enabled or disabled state. |
ExpiryDate | The expiry date to send for the secret. |
GetDeleted | Whether the component should retrieve information about soft-deleted secrets. |
MaxSecrets | The maximum number of results to return when listing secrets. |
NotBeforeDate | The 'not before' date to send for the secret. |
RawRequest | Returns the data that was sent to the server. |
RawResponse | Returns the data that was received from the server. |
VersionId | The Id of the secret version that the component should make requests against. |
XChildCount | The number of child elements of the current element. |
XChildName[i] | The name of the child element. |
XChildXText[i] | The inner text of the child element. |
XElement | The name of the current element. |
XParent | The parent of the current element. |
XPath | Provides a way to point to a specific element in the returned XML or JSON response. |
XSubTree | A snapshot of the current element in the document. |
XText | The text of the current element. |
AcceptEncoding | Used to tell the server which types of content encodings the client supports. |
AllowHTTPCompression | This property enables HTTP compression for receiving data. |
AllowHTTPFallback | Whether HTTP/2 connections are permitted to fallback to HTTP/1.1. |
Append | Whether to append data to LocalFile. |
Authorization | The Authorization string to be sent to the server. |
BytesTransferred | Contains the number of bytes transferred in the response data. |
ChunkSize | Specifies the chunk size in bytes when using chunked encoding. |
CompressHTTPRequest | Set to true to compress the body of a PUT or POST request. |
EncodeURL | If set to true the URL will be encoded by the component. |
FollowRedirects | Determines what happens when the server issues a redirect. |
GetOn302Redirect | If set to true the component will perform a GET on the new location. |
HTTP2HeadersWithoutIndexing | HTTP2 headers that should not update the dynamic header table with incremental indexing. |
HTTPVersion | The version of HTTP used by the component. |
IfModifiedSince | A date determining the maximum age of the desired document. |
KeepAlive | Determines whether the HTTP connection is closed after completion of the request. |
KerberosSPN | The Service Principal Name for the Kerberos Domain Controller. |
LogLevel | The level of detail that is logged. |
MaxRedirectAttempts | Limits the number of redirects that are followed in a request. |
NegotiatedHTTPVersion | The negotiated HTTP version. |
OtherHeaders | Other headers as determined by the user (optional). |
ProxyAuthorization | The authorization string to be sent to the proxy server. |
ProxyAuthScheme | The authorization scheme to be used for the proxy. |
ProxyPassword | A password if authentication is to be used for the proxy. |
ProxyPort | Port for the proxy server (default 80). |
ProxyServer | Name or IP address of a proxy server (optional). |
ProxyUser | A user name if authentication is to be used for the proxy. |
SentHeaders | The full set of headers as sent by the client. |
StatusLine | The first line of the last response from the server. |
TransferredData | The contents of the last response from the server. |
TransferredDataLimit | The maximum number of incoming bytes to be stored by the component. |
TransferredHeaders | The full set of headers as received from the server. |
TransferredRequest | The full request as sent by the client. |
UseChunkedEncoding | Enables or Disables HTTP chunked encoding for transfers. |
UseIDNs | Whether to encode hostnames to internationalized domain names. |
UserAgent | Information about the user agent (browser). |
CloseStreamAfterTransfer | If true, the component will close the upload or download stream after the transfer. |
ConnectionTimeout | Sets a separate timeout value for establishing a connection. |
FirewallAutoDetect | Tells the component whether or not to automatically detect and use firewall system settings, if available. |
FirewallHost | Name or IP address of firewall (optional). |
FirewallPassword | Password to be used if authentication is to be used when connecting through the firewall. |
FirewallPort | The TCP port for the FirewallHost;. |
FirewallType | Determines the type of firewall to connect through. |
FirewallUser | A user name if authentication is to be used connecting through a firewall. |
KeepAliveInterval | The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received. |
KeepAliveTime | The inactivity time in milliseconds before a TCP keep-alive packet is sent. |
Linger | When set to True, connections are terminated gracefully. |
LingerTime | Time in seconds to have the connection linger. |
LocalHost | The name of the local host through which connections are initiated or accepted. |
LocalPort | The port in the local host where the component binds. |
MaxLineLength | The maximum amount of data to accumulate when no EOL is found. |
MaxTransferRate | The transfer rate limit in bytes per second. |
ProxyExceptionsList | A semicolon separated list of hosts and IPs to bypass when using a proxy. |
TCPKeepAlive | Determines whether or not the keep alive socket option is enabled. |
TcpNoDelay | Whether or not to delay when sending packets. |
UseIPv6 | Whether to use IPv6. |
LogSSLPackets | Controls whether SSL packets are logged when using the internal security API. |
OpenSSLCADir | The path to a directory containing CA certificates. |
OpenSSLCAFile | Name of the file containing the list of CA's trusted by your application. |
OpenSSLCipherList | A string that controls the ciphers to be used by SSL. |
OpenSSLPrngSeedData | The data to seed the pseudo random number generator (PRNG). |
ReuseSSLSession | Determines if the SSL session is reused. |
SSLCACerts | A newline separated list of CA certificate to use during SSL client authentication. |
SSLCheckCRL | Whether to check the Certificate Revocation List for the server certificate. |
SSLCipherStrength | The minimum cipher strength used for bulk encryption. |
SSLEnabledCipherSuites | The cipher suite to be used in an SSL negotiation. |
SSLEnabledProtocols | Used to enable/disable the supported security protocols. |
SSLEnableRenegotiation | Whether the renegotiation_info SSL extension is supported. |
SSLIncludeCertChain | Whether the entire certificate chain is included in the SSLServerAuthentication event. |
SSLNegotiatedCipher | Returns the negotiated ciphersuite. |
SSLNegotiatedCipherStrength | Returns the negotiated ciphersuite strength. |
SSLNegotiatedCipherSuite | Returns the negotiated ciphersuite. |
SSLNegotiatedKeyExchange | Returns the negotiated key exchange algorithm. |
SSLNegotiatedKeyExchangeStrength | Returns the negotiated key exchange algorithm strength. |
SSLNegotiatedProtocol | Returns the negotiated protocol version. |
SSLProvider | The name of the security provider to use. |
SSLSecurityFlags | Flags that control certificate verification. |
SSLServerCACerts | A newline separated list of CA certificate to use during SSL server certificate validation. |
TLS12SignatureAlgorithms | Defines the allowed TLS 1.2 signature algorithms when UseInternalSecurityAPI is True. |
TLS12SupportedGroups | The supported groups for ECC. |
TLS13KeyShareGroups | The groups for which to pregenerate key shares. |
TLS13SignatureAlgorithms | The allowed certificate signature algorithms. |
TLS13SupportedGroups | The supported groups for (EC)DHE key exchange. |
AbsoluteTimeout | Determines whether timeouts are inactivity timeouts or absolute timeouts. |
FirewallData | Used to send extra data to the firewall. |
InBufferSize | The size in bytes of the incoming queue of the socket. |
OutBufferSize | The size in bytes of the outgoing queue of the socket. |
BuildInfo | Information about the product's build. |
CodePage | The system code page used for Unicode to Multibyte translations. |
LicenseInfo | Information about the current license. |
UseInternalSecurityAPI | Tells the component whether or not to use the system security libraries or an internal implementation. |