/* * Copyright 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. */ using Amazon.Runtime.Internal.Util; using Amazon.Util; using System; namespace Amazon.Runtime { /// <summary> /// Immutable representation of AWS credentials. /// </summary> public class ImmutableCredentials { #region Properties /// <summary> /// Gets the AccessKey property for the current credentials. /// </summary> public string AccessKey { get; private set; } /// <summary> /// Gets the SecretKey property for the current credentials. /// </summary> public string SecretKey { get; private set; } /// <summary> /// Gets the Token property for the current credentials. /// </summary> public string Token { get; private set; } /// <summary> /// Gets the UseToken property for the current credentials. /// Specifies if Token property is non-empty. /// </summary> public bool UseToken { get { return !string.IsNullOrEmpty(Token); } } #endregion #region Constructors /// <summary> /// Constructs an ImmutableCredentials object with supplied accessKey, secretKey. /// </summary> /// <param name="awsAccessKeyId"></param> /// <param name="awsSecretAccessKey"></param> /// <param name="token">Optional. Can be set to null or empty for non-session credentials.</param> public ImmutableCredentials(string awsAccessKeyId, string awsSecretAccessKey, string token) { if (string.IsNullOrEmpty(awsAccessKeyId)) throw new ArgumentNullException("awsAccessKeyId"); if (string.IsNullOrEmpty(awsSecretAccessKey)) throw new ArgumentNullException("awsSecretAccessKey"); AccessKey = awsAccessKeyId; SecretKey = awsSecretAccessKey; Token = token ?? string.Empty; } private ImmutableCredentials() { } #endregion #region Public methods /// <summary> /// Returns a copy of the current credentials. /// </summary> /// <returns></returns> public virtual ImmutableCredentials Copy() { ImmutableCredentials credentials = new ImmutableCredentials { AccessKey = this.AccessKey, SecretKey = this.SecretKey, Token = this.Token, }; return credentials; } #endregion #region Overrides public override int GetHashCode() { return Hashing.Hash(AccessKey, SecretKey, Token); } public override bool Equals(object obj) { if (object.ReferenceEquals(this, obj)) return true; ImmutableCredentials ic = obj as ImmutableCredentials; if (ic == null) return false; return AWSSDKUtils.AreEqual( new object[] { AccessKey, SecretKey, Token }, new object[] { ic.AccessKey, ic.SecretKey, ic.Token }); } #endregion } }