/*******************************************************************************
* 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.SSOOIDC;
using Amazon.SSOOIDC.Model;
namespace Amazon.PowerShell.Cmdlets.SSOOIDC
{
///
/// Creates and returns an access token for the authorized client. The access token issued
/// will be used to fetch short-term credentials for the assigned roles in the AWS account.
///
[Cmdlet("New", "SSOOIDCToken", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)]
[OutputType("Amazon.SSOOIDC.Model.CreateTokenResponse")]
[AWSCmdlet("Calls the AWS Single Sign-On OIDC CreateToken API operation.", Operation = new[] {"CreateToken"}, SelectReturnType = typeof(Amazon.SSOOIDC.Model.CreateTokenResponse))]
[AWSCmdletOutput("Amazon.SSOOIDC.Model.CreateTokenResponse",
"This cmdlet returns an Amazon.SSOOIDC.Model.CreateTokenResponse object containing multiple properties. The object can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack."
)]
public partial class NewSSOOIDCTokenCmdlet : AmazonSSOOIDCClientCmdlet, IExecutor
{
#region Parameter ClientId
///
///
/// The unique identifier string for each client. This value should come from the persisted
/// result of the RegisterClient API.
///
///
#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.AllowEmptyString]
[System.Management.Automation.AllowNull]
#endif
[Amazon.PowerShell.Common.AWSRequiredParameter]
public System.String ClientId { get; set; }
#endregion
#region Parameter ClientSecret
///
///
/// A secret string generated for the client. This value should come from the persisted
/// result of the RegisterClient API.
///
///
#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 ClientSecret { get; set; }
#endregion
#region Parameter Code
///
///
/// The authorization code received from the authorization service. This parameter is
/// required to perform an authorization grant request to get access to a token.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String Code { get; set; }
#endregion
#region Parameter DeviceCode
///
///
/// Used only when calling this API for the device code grant type. This short-term code
/// is used to identify this authentication attempt. This should come from an in-memory
/// reference to the result of the StartDeviceAuthorization API.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String DeviceCode { get; set; }
#endregion
#region Parameter GrantType
///
///
/// Supports grant types for the authorization code, refresh token, and device code request.
/// For device code requests, specify the following value:urn:ietf:params:oauth:grant-type:device_code
For information about how to obtain the device code, see the StartDeviceAuthorization
/// topic.
///
///
#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 GrantType { get; set; }
#endregion
#region Parameter RedirectUri
///
///
/// The location of the application that will receive the authorization code. Users authorize
/// the service to send the request to this location.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String RedirectUri { get; set; }
#endregion
#region Parameter RefreshToken
///
///
/// Currently, refreshToken
is not yet implemented and is not supported.
/// For more information about the features and limitations of the current IAM Identity
/// Center OIDC implementation, see Considerations for Using this Guide in the
/// IAM
/// Identity Center OIDC API Reference.The token used to obtain an access token in the event that the access token is invalid
/// or expired.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String RefreshToken { get; set; }
#endregion
#region Parameter Scope
///
///
/// The list of scopes that is defined by the client. Upon authorization, this list is
/// used to restrict permissions when granting an access token.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String[] Scope { get; set; }
#endregion
#region Parameter Select
///
/// 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.SSOOIDC.Model.CreateTokenResponse).
/// Specifying the name of a property of type Amazon.SSOOIDC.Model.CreateTokenResponse 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; } = "*";
#endregion
#region Parameter PassThru
///
/// Changes the cmdlet behavior to return the value passed to the ClientId parameter.
/// The -PassThru parameter is deprecated, use -Select '^ClientId' instead. This parameter will be removed in a future version.
///
[System.Obsolete("The -PassThru parameter is deprecated, use -Select '^ClientId' instead. This parameter will be removed in a future version.")]
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public SwitchParameter PassThru { get; set; }
#endregion
#region Parameter Force
///
/// This parameter overrides confirmation prompts to force
/// the cmdlet to continue its operation. This parameter should always
/// be used with caution.
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public SwitchParameter Force { get; set; }
#endregion
protected override void ProcessRecord()
{
this._AWSSignerType = "v4";
base.ProcessRecord();
var resourceIdentifiersText = FormatParameterValuesForConfirmationMsg(nameof(this.ClientId), MyInvocation.BoundParameters);
if (!ConfirmShouldProceed(this.Force.IsPresent, resourceIdentifiersText, "New-SSOOIDCToken (CreateToken)"))
{
return;
}
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.ClientId;
}
#pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute
context.ClientId = this.ClientId;
#if MODULAR
if (this.ClientId == null && ParameterWasBound(nameof(this.ClientId)))
{
WriteWarning("You are passing $null as a value for parameter ClientId 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.ClientSecret = this.ClientSecret;
#if MODULAR
if (this.ClientSecret == null && ParameterWasBound(nameof(this.ClientSecret)))
{
WriteWarning("You are passing $null as a value for parameter ClientSecret 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.Code = this.Code;
context.DeviceCode = this.DeviceCode;
context.GrantType = this.GrantType;
#if MODULAR
if (this.GrantType == null && ParameterWasBound(nameof(this.GrantType)))
{
WriteWarning("You are passing $null as a value for parameter GrantType 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.RedirectUri = this.RedirectUri;
context.RefreshToken = this.RefreshToken;
if (this.Scope != null)
{
context.Scope = new List(this.Scope);
}
// 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)
{
var cmdletContext = context as CmdletContext;
// create request
var request = new Amazon.SSOOIDC.Model.CreateTokenRequest();
if (cmdletContext.ClientId != null)
{
request.ClientId = cmdletContext.ClientId;
}
if (cmdletContext.ClientSecret != null)
{
request.ClientSecret = cmdletContext.ClientSecret;
}
if (cmdletContext.Code != null)
{
request.Code = cmdletContext.Code;
}
if (cmdletContext.DeviceCode != null)
{
request.DeviceCode = cmdletContext.DeviceCode;
}
if (cmdletContext.GrantType != null)
{
request.GrantType = cmdletContext.GrantType;
}
if (cmdletContext.RedirectUri != null)
{
request.RedirectUri = cmdletContext.RedirectUri;
}
if (cmdletContext.RefreshToken != null)
{
request.RefreshToken = cmdletContext.RefreshToken;
}
if (cmdletContext.Scope != null)
{
request.Scope = cmdletContext.Scope;
}
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;
}
public ExecutorContext CreateContext()
{
return new CmdletContext();
}
#endregion
#region AWS Service Operation Call
private Amazon.SSOOIDC.Model.CreateTokenResponse CallAWSServiceOperation(IAmazonSSOOIDC client, Amazon.SSOOIDC.Model.CreateTokenRequest request)
{
Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "AWS Single Sign-On OIDC", "CreateToken");
try
{
#if DESKTOP
return client.CreateToken(request);
#elif CORECLR
return client.CreateTokenAsync(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.String ClientId { get; set; }
public System.String ClientSecret { get; set; }
public System.String Code { get; set; }
public System.String DeviceCode { get; set; }
public System.String GrantType { get; set; }
public System.String RedirectUri { get; set; }
public System.String RefreshToken { get; set; }
public List Scope { get; set; }
public System.Func Select { get; set; } =
(response, cmdlet) => response;
}
}
}