/******************************************************************************* * Copyright 2012-2019 Amazon.com, Inc. or its affiliates. All Rights Reserved. * Licensed under the Apache License, Version 2.0 (the "License"). You may not use * this file except in compliance with the License. A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. * This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR * CONDITIONS OF ANY KIND, either express or implied. See the License for the * specific language governing permissions and limitations under the License. * ***************************************************************************** * * AWS Tools for Windows (TM) PowerShell (TM) * */ using System; using System.Collections.Generic; using System.Linq; using System.Management.Automation; using System.Text; using Amazon.PowerShell.Common; using Amazon.Runtime; using Amazon.KeyManagementService; using Amazon.KeyManagementService.Model; namespace Amazon.PowerShell.Cmdlets.KMS { /// /// Verifies a digital signature that was generated by the Sign operation. /// /// /// /// Verification confirms that an authorized user signed the message with the specified /// KMS key and signing algorithm, and the message hasn't changed since it was signed. /// If the signature is verified, the value of the SignatureValid field in /// the response is True. If the signature verification fails, the Verify /// operation fails with an KMSInvalidSignatureException exception. /// /// A digital signature is generated by using the private key in an asymmetric KMS key. /// The signature is verified by using the public key in the same asymmetric KMS key. /// For information about asymmetric KMS keys, see Asymmetric /// KMS keys in the Key Management Service Developer Guide. /// /// To use the Verify operation, specify the same asymmetric KMS key, message, /// and signing algorithm that were used to produce the signature. The message type does /// not need to be the same as the one used for signing, but it must indicate whether /// the value of the Message parameter should be hashed as part of the verification /// process. /// /// You can also verify the digital signature by using the public key of the KMS key outside /// of KMS. Use the GetPublicKey operation to download the public key in the asymmetric /// KMS key and then use the public key to verify the signature outside of KMS. The advantage /// of using the Verify operation is that it is performed within KMS. As /// a result, it's easy to call, the operation is performed within the FIPS boundary, /// it is logged in CloudTrail, and you can use key policy and IAM policy to determine /// who is authorized to use the KMS key to verify signatures. /// /// To verify a signature outside of KMS with an SM2 public key (China Regions only), /// you must specify the distinguishing ID. By default, KMS uses 1234567812345678 /// as the distinguishing ID. For more information, see Offline /// verification with SM2 key pairs. /// /// The KMS key that you use for this operation must be in a compatible key state. For /// details, see Key /// states of KMS keys in the Key Management Service Developer Guide. /// Cross-account use: Yes. To perform this operation with a KMS key in a different /// Amazon Web Services account, specify the key ARN or alias ARN in the value of the /// KeyId parameter. /// Required permissions: kms:Verify /// (key policy) /// Related operations: Sign /// [Cmdlet("Test", "KMSSignature")] [OutputType("System.Boolean")] [AWSCmdlet("Calls the AWS Key Management Service Verify API operation.", Operation = new[] {"Verify"}, SelectReturnType = typeof(Amazon.KeyManagementService.Model.VerifyResponse))] [AWSCmdletOutput("System.Boolean or Amazon.KeyManagementService.Model.VerifyResponse", "This cmdlet returns a System.Boolean object.", "The service call response (type Amazon.KeyManagementService.Model.VerifyResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack." )] public partial class TestKMSSignatureCmdlet : AmazonKeyManagementServiceClientCmdlet, IExecutor { protected override bool IsSensitiveRequest { get; set; } = true; #region Parameter DryRun /// /// /// Checks if your request will succeed. DryRun is an optional parameter. /// To learn more about how to use this parameter, see Testing /// your KMS API calls in the Key Management Service Developer Guide. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.Boolean? DryRun { get; set; } #endregion #region Parameter GrantToken /// /// /// A list of grant tokens.Use a grant token when your permission to call this operation comes from a new grant /// that has not yet achieved eventual consistency. For more information, see Grant /// token and Using /// a grant token in the Key Management Service Developer Guide. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("GrantTokens")] public System.String[] GrantToken { get; set; } #endregion #region Parameter KeyId /// /// /// Identifies the asymmetric KMS key that will be used to verify the signature. This /// must be the same KMS key that was used to generate the signature. If you specify a /// different KMS key, the signature verification fails.To specify a KMS key, use its key ID, key ARN, alias name, or alias ARN. When using /// an alias name, prefix it with "alias/". To specify a KMS key in a different /// Amazon Web Services account, you must use the key ARN or alias ARN.For example:To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey. /// To get the alias name and alias ARN, use ListAliases. /// /// #if !MODULAR [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] #else [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true, Mandatory = true)] [System.Management.Automation.AllowEmptyString] [System.Management.Automation.AllowNull] #endif [Amazon.PowerShell.Common.AWSRequiredParameter] public System.String KeyId { get; set; } #endregion #region Parameter Message /// /// /// Specifies the message that was signed. You can submit a raw message of up to 4096 /// bytes, or a hash digest of the message. If you submit a digest, use the MessageType /// parameter with a value of DIGEST.If the message specified here is different from the message that was signed, the signature /// verification fails. A message and its hash digest are considered to be the same message. /// /// The cmdlet will automatically convert the supplied parameter of type string, string[], System.IO.FileInfo or System.IO.Stream to byte[] before supplying it to the service. /// #if !MODULAR [System.Management.Automation.Parameter(Position = 0, ValueFromPipelineByPropertyName = true, ValueFromPipeline = true)] #else [System.Management.Automation.Parameter(Position = 0, ValueFromPipelineByPropertyName = true, ValueFromPipeline = true, Mandatory = true)] [System.Management.Automation.AllowNull] #endif [Amazon.PowerShell.Common.AWSRequiredParameter] [Amazon.PowerShell.Common.MemoryStreamParameterConverter] public byte[] Message { get; set; } #endregion #region Parameter MessageType /// /// /// Tells KMS whether the value of the Message parameter should be hashed /// as part of the signing algorithm. Use RAW for unhashed messages; use /// DIGEST for message digests, which are already hashed.When the value of MessageType is RAW, KMS uses the standard /// signing algorithm, which begins with a hash function. When the value is DIGEST, /// KMS skips the hashing step in the signing algorithm.Use the DIGEST value only when the value of the Message /// parameter is a message digest. If you use the DIGEST value with an unhashed /// message, the security of the verification operation can be compromised.When the value of MessageTypeis DIGEST, the length of the /// Message value must match the length of hashed messages for the specified /// signing algorithm.You can submit a message digest and omit the MessageType or specify RAW /// so the digest is hashed again while signing. However, if the signed message is hashed /// once while signing, but twice while verifying, verification fails, even when the message /// hasn't changed.The hashing algorithm in that Verify uses is based on the SigningAlgorithm /// value. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [AWSConstantClassSource("Amazon.KeyManagementService.MessageType")] public Amazon.KeyManagementService.MessageType MessageType { get; set; } #endregion #region Parameter Signature /// /// /// The signature that the Sign operation generated. /// /// The cmdlet will automatically convert the supplied parameter of type string, string[], System.IO.FileInfo or System.IO.Stream to byte[] before supplying it to the service. /// #if !MODULAR [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] #else [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true, Mandatory = true)] [System.Management.Automation.AllowNull] #endif [Amazon.PowerShell.Common.AWSRequiredParameter] [Amazon.PowerShell.Common.MemoryStreamParameterConverter] public byte[] Signature { get; set; } #endregion #region Parameter SigningAlgorithm /// /// /// The signing algorithm that was used to sign the message. If you submit a different /// algorithm, the signature verification fails. /// /// #if !MODULAR [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] #else [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true, Mandatory = true)] [System.Management.Automation.AllowNull] #endif [Amazon.PowerShell.Common.AWSRequiredParameter] [AWSConstantClassSource("Amazon.KeyManagementService.SigningAlgorithmSpec")] public Amazon.KeyManagementService.SigningAlgorithmSpec SigningAlgorithm { get; set; } #endregion #region Parameter Select /// /// Use the -Select parameter to control the cmdlet output. The default value is 'SignatureValid'. /// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.KeyManagementService.Model.VerifyResponse). /// Specifying the name of a property of type Amazon.KeyManagementService.Model.VerifyResponse will result in that property being returned. /// Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public string Select { get; set; } = "SignatureValid"; #endregion #region Parameter PassThru /// /// Changes the cmdlet behavior to return the value passed to the Message parameter. /// The -PassThru parameter is deprecated, use -Select '^Message' instead. This parameter will be removed in a future version. /// [System.Obsolete("The -PassThru parameter is deprecated, use -Select '^Message' instead. This parameter will be removed in a future version.")] [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public SwitchParameter PassThru { get; set; } #endregion protected override void ProcessRecord() { this._AWSSignerType = "v4"; base.ProcessRecord(); var context = new CmdletContext(); // allow for manipulation of parameters prior to loading into context PreExecutionContextLoad(context); #pragma warning disable CS0618, CS0612 //A class member was marked with the Obsolete attribute if (ParameterWasBound(nameof(this.Select))) { context.Select = CreateSelectDelegate(Select) ?? throw new System.ArgumentException("Invalid value for -Select parameter.", nameof(this.Select)); if (this.PassThru.IsPresent) { throw new System.ArgumentException("-PassThru cannot be used when -Select is specified.", nameof(this.Select)); } } else if (this.PassThru.IsPresent) { context.Select = (response, cmdlet) => this.Message; } #pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute context.DryRun = this.DryRun; if (this.GrantToken != null) { context.GrantToken = new List(this.GrantToken); } context.KeyId = this.KeyId; #if MODULAR if (this.KeyId == null && ParameterWasBound(nameof(this.KeyId))) { WriteWarning("You are passing $null as a value for parameter KeyId which is marked as required. In case you believe this parameter was incorrectly marked as required, report this by opening an issue at https://github.com/aws/aws-tools-for-powershell/issues."); } #endif context.Message = this.Message; #if MODULAR if (this.Message == null && ParameterWasBound(nameof(this.Message))) { WriteWarning("You are passing $null as a value for parameter Message which is marked as required. In case you believe this parameter was incorrectly marked as required, report this by opening an issue at https://github.com/aws/aws-tools-for-powershell/issues."); } #endif context.MessageType = this.MessageType; context.Signature = this.Signature; #if MODULAR if (this.Signature == null && ParameterWasBound(nameof(this.Signature))) { WriteWarning("You are passing $null as a value for parameter Signature which is marked as required. In case you believe this parameter was incorrectly marked as required, report this by opening an issue at https://github.com/aws/aws-tools-for-powershell/issues."); } #endif context.SigningAlgorithm = this.SigningAlgorithm; #if MODULAR if (this.SigningAlgorithm == null && ParameterWasBound(nameof(this.SigningAlgorithm))) { WriteWarning("You are passing $null as a value for parameter SigningAlgorithm which is marked as required. In case you believe this parameter was incorrectly marked as required, report this by opening an issue at https://github.com/aws/aws-tools-for-powershell/issues."); } #endif // allow further manipulation of loaded context prior to processing PostExecutionContextLoad(context); var output = Execute(context) as CmdletOutput; ProcessOutput(output); } #region IExecutor Members public object Execute(ExecutorContext context) { System.IO.MemoryStream _MessageStream = null; System.IO.MemoryStream _SignatureStream = null; try { var cmdletContext = context as CmdletContext; // create request var request = new Amazon.KeyManagementService.Model.VerifyRequest(); if (cmdletContext.DryRun != null) { request.DryRun = cmdletContext.DryRun.Value; } if (cmdletContext.GrantToken != null) { request.GrantTokens = cmdletContext.GrantToken; } if (cmdletContext.KeyId != null) { request.KeyId = cmdletContext.KeyId; } if (cmdletContext.Message != null) { _MessageStream = new System.IO.MemoryStream(cmdletContext.Message); request.Message = _MessageStream; } if (cmdletContext.MessageType != null) { request.MessageType = cmdletContext.MessageType; } if (cmdletContext.Signature != null) { _SignatureStream = new System.IO.MemoryStream(cmdletContext.Signature); request.Signature = _SignatureStream; } if (cmdletContext.SigningAlgorithm != null) { request.SigningAlgorithm = cmdletContext.SigningAlgorithm; } CmdletOutput output; // issue call var client = Client ?? CreateClient(_CurrentCredentials, _RegionEndpoint); try { var response = CallAWSServiceOperation(client, request); object pipelineOutput = null; pipelineOutput = cmdletContext.Select(response, this); output = new CmdletOutput { PipelineOutput = pipelineOutput, ServiceResponse = response }; } catch (Exception e) { output = new CmdletOutput { ErrorResponse = e }; } return output; } finally { if( _MessageStream != null) { _MessageStream.Dispose(); } if( _SignatureStream != null) { _SignatureStream.Dispose(); } } } public ExecutorContext CreateContext() { return new CmdletContext(); } #endregion #region AWS Service Operation Call private Amazon.KeyManagementService.Model.VerifyResponse CallAWSServiceOperation(IAmazonKeyManagementService client, Amazon.KeyManagementService.Model.VerifyRequest request) { Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "AWS Key Management Service", "Verify"); try { #if DESKTOP return client.Verify(request); #elif CORECLR return client.VerifyAsync(request).GetAwaiter().GetResult(); #else #error "Unknown build edition" #endif } catch (AmazonServiceException exc) { var webException = exc.InnerException as System.Net.WebException; if (webException != null) { throw new Exception(Utils.Common.FormatNameResolutionFailureMessage(client.Config, webException.Message), webException); } throw; } } #endregion internal partial class CmdletContext : ExecutorContext { public System.Boolean? DryRun { get; set; } public List GrantToken { get; set; } public System.String KeyId { get; set; } public byte[] Message { get; set; } public Amazon.KeyManagementService.MessageType MessageType { get; set; } public byte[] Signature { get; set; } public Amazon.KeyManagementService.SigningAlgorithmSpec SigningAlgorithm { get; set; } public System.Func Select { get; set; } = (response, cmdlet) => response.SignatureValid; } } }