AWS Tools for Windows PowerShell
Command Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Synopsis

Calls the Payment Cryptography Data EncryptData API operation.

Syntax

Protect-PAYCDData
-KeyIdentifier <String>
-DiffieHellmanSymmetricKey_CertificateAuthorityPublicKeyIdentifier <String>
-Dukpt_DukptKeyDerivationType <DukptDerivationType>
-Dukpt_DukptKeyVariant <DukptKeyVariant>
-Dukpt_InitializationVector <String>
-Emv_InitializationVector <String>
-Symmetric_InitializationVector <String>
-DiffieHellmanSymmetricKey_KeyAlgorithm <SymmetricKeyAlgorithm>
-WrappedKey_KeyCheckValueAlgorithm <KeyCheckValueAlgorithm>
-DiffieHellmanSymmetricKey_KeyDerivationFunction <KeyDerivationFunction>
-DiffieHellmanSymmetricKey_KeyDerivationHashAlgorithm <KeyDerivationHashAlgorithm>
-Dukpt_KeySerialNumber <String>
-Emv_MajorKeyDerivationMode <EmvMajorKeyDerivationMode>
-Dukpt_Mode <DukptEncryptionMode>
-Emv_Mode <EmvEncryptionMode>
-Symmetric_Mode <EncryptionMode>
-Asymmetric_PaddingType <PaddingType>
-Symmetric_PaddingType <PaddingType>
-Emv_PanSequenceNumber <String>
-PlainText <String>
-Emv_PrimaryAccountNumber <String>
-DiffieHellmanSymmetricKey_PublicKeyCertificate <String>
-Emv_SessionDerivationData <String>
-DiffieHellmanSymmetricKey_SharedInformation <String>
-WrappedKeyMaterial_Tr31KeyBlock <String>
-Select <String>
-Force <SwitchParameter>
-ClientConfig <AmazonPaymentCryptographyDataConfig>

Description

Encrypts plaintext data to ciphertext using a symmetric (TDES, AES), asymmetric (RSA), or derived (DUKPT or EMV) encryption key scheme. For more information, see Encrypt data in the Amazon Web Services Payment Cryptography User Guide. You can generate an encryption key within Amazon Web Services Payment Cryptography by calling CreateKey. You can import your own encryption key by calling ImportKey. For this operation, the key must have KeyModesOfUse set to Encrypt. In asymmetric encryption, plaintext is encrypted using public component. You can import the public component of an asymmetric key pair created outside Amazon Web Services Payment Cryptography by calling ImportKey. This operation also supports dynamic keys, allowing you to pass a dynamic encryption key as a TR-31 WrappedKeyBlock. This can be used when key material is frequently rotated, such as during every card transaction, and there is need to avoid importing short-lived keys into Amazon Web Services Payment Cryptography. To encrypt using dynamic keys, the keyARN is the Key Encryption Key (KEK) of the TR-31 wrapped encryption key material. The incoming wrapped key shall have a key purpose of D0 with a mode of use of B or D. For more information, see Using Dynamic Keys in the Amazon Web Services Payment Cryptography User Guide. For symmetric and DUKPT encryption, Amazon Web Services Payment Cryptography supports TDES and AES algorithms. For EMV encryption, Amazon Web Services Payment Cryptography supports TDES algorithms.For asymmetric encryption, Amazon Web Services Payment Cryptography supports RSA. When you use TDES or TDES DUKPT, the plaintext data length must be a multiple of 8 bytes. For AES or AES DUKPT, the plaintext data length must be a multiple of 16 bytes. For RSA, it sould be equal to the key size unless padding is enabled. To encrypt using DUKPT, you must already have a BDK (Base Derivation Key) key in your account with KeyModesOfUse set to DeriveKey, or you can generate a new DUKPT key by calling CreateKey. To encrypt using EMV, you must already have an IMK (Issuer Master Key) key in your account with KeyModesOfUse set to DeriveKey. For information about valid keys for this operation, see Understanding key attributes and Key types for specific data operations in the Amazon Web Services Payment Cryptography User Guide. Cross-account use: This operation can't be used across different Amazon Web Services accounts. Related operations:

Parameters

-Asymmetric_PaddingType <PaddingType>
The padding to be included with the data.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesEncryptionAttributes_Asymmetric_PaddingType
-ClientConfig <AmazonPaymentCryptographyDataConfig>
Amazon.PowerShell.Cmdlets.PAYCD.AmazonPaymentCryptographyDataClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DiffieHellmanSymmetricKey_CertificateAuthorityPublicKeyIdentifier <String>
The keyArn of the certificate that signed the client's PublicKeyCertificate.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesWrappedKey_WrappedKeyMaterial_DiffieHellmanSymmetricKey_CertificateAuthorityPublicKeyIdentifier
-DiffieHellmanSymmetricKey_KeyAlgorithm <SymmetricKeyAlgorithm>
The key algorithm of the derived ECDH key.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesWrappedKey_WrappedKeyMaterial_DiffieHellmanSymmetricKey_KeyAlgorithm
-DiffieHellmanSymmetricKey_KeyDerivationFunction <KeyDerivationFunction>
The key derivation function to use for deriving a key using ECDH.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesWrappedKey_WrappedKeyMaterial_DiffieHellmanSymmetricKey_KeyDerivationFunction
-DiffieHellmanSymmetricKey_KeyDerivationHashAlgorithm <KeyDerivationHashAlgorithm>
The hash type to use for deriving a key using ECDH.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesWrappedKey_WrappedKeyMaterial_DiffieHellmanSymmetricKey_KeyDerivationHashAlgorithm
-DiffieHellmanSymmetricKey_PublicKeyCertificate <String>
The client's public key certificate in PEM format (base64 encoded) to use for ECDH key derivation.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesWrappedKey_WrappedKeyMaterial_DiffieHellmanSymmetricKey_PublicKeyCertificate
-DiffieHellmanSymmetricKey_SharedInformation <String>
A byte string containing information that binds the ECDH derived key to the two parties involved or to the context of the key.It may include details like identities of the two parties deriving the key, context of the operation, session IDs, and optionally a nonce. It must not contain zero bytes, and re-using shared information for multiple ECDH key derivations is not recommended.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesWrappedKey_WrappedKeyMaterial_DiffieHellmanSymmetricKey_SharedInformation
-Dukpt_DukptKeyDerivationType <DukptDerivationType>
The key type encrypted using DUKPT from a Base Derivation Key (BDK) and Key Serial Number (KSN). This must be less than or equal to the strength of the BDK. For example, you can't use AES_128 as a derivation type for a BDK of AES_128 or TDES_2KEY
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesEncryptionAttributes_Dukpt_DukptKeyDerivationType
-Dukpt_DukptKeyVariant <DukptKeyVariant>
The type of use of DUKPT, which can be incoming data decryption, outgoing data encryption, or both.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesEncryptionAttributes_Dukpt_DukptKeyVariant
-Dukpt_InitializationVector <String>
An input used to provide the intial state. If no value is provided, Amazon Web Services Payment Cryptography defaults it to zero.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesEncryptionAttributes_Dukpt_InitializationVector
-Dukpt_KeySerialNumber <String>
The unique identifier known as Key Serial Number (KSN) that comes from an encrypting device using DUKPT encryption method. The KSN is derived from the encrypting device unique identifier and an internal transaction counter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesEncryptionAttributes_Dukpt_KeySerialNumber
-Dukpt_Mode <DukptEncryptionMode>
The block cipher method to use for encryption.The default is CBC.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesEncryptionAttributes_Dukpt_Mode
-Emv_InitializationVector <String>
An input used to provide the intial state. If no value is provided, Amazon Web Services Payment Cryptography defaults it to zero.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesEncryptionAttributes_Emv_InitializationVector
-Emv_MajorKeyDerivationMode <EmvMajorKeyDerivationMode>
The EMV derivation mode to use for ICC master key derivation as per EMV version 4.3 book 2.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesEncryptionAttributes_Emv_MajorKeyDerivationMode
-Emv_Mode <EmvEncryptionMode>
The block cipher method to use for encryption.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesEncryptionAttributes_Emv_Mode
-Emv_PanSequenceNumber <String>
A number that identifies and differentiates payment cards with the same Primary Account Number (PAN). Typically 00 is used, if no value is provided by the terminal.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesEncryptionAttributes_Emv_PanSequenceNumber
-Emv_PrimaryAccountNumber <String>
The Primary Account Number (PAN), a unique identifier for a payment credit or debit card and associates the card to a specific account holder.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesEncryptionAttributes_Emv_PrimaryAccountNumber
-Emv_SessionDerivationData <String>
The derivation value used to derive the ICC session key. It is typically the application transaction counter value padded with zeros or previous ARQC value padded with zeros as per EMV version 4.3 book 2.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesEncryptionAttributes_Emv_SessionDerivationData
-Force <SwitchParameter>
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-KeyIdentifier <String>
The keyARN of the encryption key that Amazon Web Services Payment Cryptography uses for plaintext encryption.When a WrappedKeyBlock is provided, this value will be the identifier to the key wrapping key. Otherwise, it is the key identifier used to perform the operation.
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-PlainText <String>
The plaintext to be encrypted.For encryption using asymmetric keys, plaintext data length is constrained by encryption key strength that you define in KeyAlgorithm and padding type that you define in AsymmetricEncryptionAttributes. For more information, see Encrypt data in the Amazon Web Services Payment Cryptography User Guide.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.PaymentCryptographyData.Model.EncryptDataResponse). Specifying the name of a property of type Amazon.PaymentCryptographyData.Model.EncryptDataResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Symmetric_InitializationVector <String>
An input used to provide the intial state. If no value is provided, Amazon Web Services Payment Cryptography defaults it to zero.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesEncryptionAttributes_Symmetric_InitializationVector
-Symmetric_Mode <EncryptionMode>
The block cipher method to use for encryption.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesEncryptionAttributes_Symmetric_Mode
-Symmetric_PaddingType <PaddingType>
The padding to be included with the data.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesEncryptionAttributes_Symmetric_PaddingType
-WrappedKey_KeyCheckValueAlgorithm <KeyCheckValueAlgorithm>
The algorithm that Amazon Web Services Payment Cryptography uses to calculate the key check value (KCV). It is used to validate the key integrity.For TDES keys, the KCV is computed by encrypting 8 bytes, each with value of zero, with the key to be checked and retaining the 3 highest order bytes of the encrypted result. For AES keys, the KCV is computed using a CMAC algorithm where the input data is 16 bytes of zero and retaining the 3 highest order bytes of the encrypted result.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-WrappedKeyMaterial_Tr31KeyBlock <String>
The TR-31 wrapped key block.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesWrappedKey_WrappedKeyMaterial_Tr31KeyBlock

Common Credential and Region Parameters

-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAK
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-EndpointUrl <String>
The endpoint to make the call against.Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-ProfileLocation <String>
Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials.If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAWSProfilesLocation, ProfilesLocation
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStoredCredentials, AWSProfileName
-Region <Object>
The system name of an AWS region or an AWSRegion instance. This governs the endpoint that will be used when calling service operations. Note that the AWS resources referenced in a call are usually region-specific.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRegionToCall
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSK, SecretAccessKey
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesST

Outputs

Amazon.PaymentCryptographyData.Model.EncryptDataResponse
This cmdlet returns an Amazon.PaymentCryptographyData.Model.EncryptDataResponse object containing multiple properties.
AWS Tools for PowerShell User Guide

Supported Version

AWS Tools for PowerShell: 2.x.y.z