Skip to content

Latest commit

 

History

History
197 lines (152 loc) · 6.07 KB

decrypt-file-v1.md

File metadata and controls

197 lines (152 loc) · 6.07 KB
Raw
title description ms.date monikerRange
DecryptFile@1 - Decrypt file (OpenSSL) v1 task
Decrypt a file using OpenSSL.
07/02/2024
<=azure-pipelines

DecryptFile@1 - Decrypt file (OpenSSL) v1 task

:::moniker range=">=azure-pipelines-2019.1"

Use this task to decrypt files using OpenSSL.

:::moniker-end

:::moniker range="=azure-pipelines-2019"

A thin utility task for file decryption using OpenSSL.

:::moniker-end

Syntax

:::moniker range=">=azure-pipelines-2019.1"

# Decrypt file (OpenSSL) v1
# Decrypt a file using OpenSSL.
- task: DecryptFile@1
  inputs:
    cipher: 'des3' # string. Required. Cypher. Default: des3.
    inFile: # string. Required. Encrypted file. 
    passphrase: # string. Required. Passphrase. 
    #outFile: # string. Decrypted file path. 
  # Advanced
    #workingDirectory: # string. Alias: cwd. Working directory.

:::moniker-end

:::moniker range="=azure-pipelines-2019"

# Decrypt File (OpenSSL) v1
# A thin utility task for file decryption using OpenSSL.
- task: DecryptFile@1
  inputs:
    cipher: 'des3' # string. Required. Cypher. Default: des3.
    inFile: # string. Required. Encrypted file. 
    passphrase: # string. Required. Passphrase. 
    #outFile: # string. Decrypted file path. 
  # Advanced
    #workingDirectory: # string. Alias: cwd. Working directory.

:::moniker-end

Inputs

:::moniker range="<=azure-pipelines"

cipher - Cypher
string. Required. Default value: des3.

The encryption cypher to use. See cypher suite names for a complete list of possible values.


:::moniker-end

:::moniker range="<=azure-pipelines"

inFile - Encrypted file
string. Required.

The relative path of the file to decrypt.


:::moniker-end

:::moniker range="<=azure-pipelines"

passphrase - Passphrase
string. Required.

The passphrase to use for decryption. Use a variable to encrypt the passphrase.


:::moniker-end

:::moniker range="<=azure-pipelines"

outFile - Decrypted file path
string.

The optional filename for the decrypted file. Defaults to the encrypted file with an .out extension.


:::moniker-end

:::moniker range="<=azure-pipelines"

workingDirectory - Working directory
Input alias: cwd. string.

The optional working directory for decryption. Defaults to the root of the repository.


:::moniker-end

Task control options

All tasks have control options in addition to their task inputs. For more information, see Control options and common task properties.

Output variables

:::moniker range="<=azure-pipelines"

None.

:::moniker-end

Remarks

Use this task to decrypt files using OpenSSL.

Requirements

:::moniker range=">=azure-pipelines-2022"

Requirement Description
Pipeline types YAML, Classic build, Classic release
Runs on Agent, DeploymentGroup
Demands None
Capabilities This task does not satisfy any demands for subsequent tasks in the job.
Command restrictions This task runs using the following command restrictions: restricted
Settable variables This task has permission to set the following variables: Setting variables is disabled
Agent version 2.182.1 or greater
Task category Utility

:::moniker-end

:::moniker range="<=azure-pipelines-2020.1"

Requirement Description
Pipeline types YAML, Classic build, Classic release
Runs on Agent, DeploymentGroup
Demands None
Capabilities This task does not satisfy any demands for subsequent tasks in the job.
Command restrictions Any
Settable variables Any
Agent version All supported agent versions.
Task category Utility

:::moniker-end