com.aliyun.oss.common.utils

Class AuthUtils

java.lang.Object

com.aliyun.oss.common.utils.AuthUtils

public class AuthUtils
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
static String	ACCESS_KEY_ENV_VAR Environment variable name for the oss access key ID
static String	ACCESS_KEY_SYSTEM_PROPERTY System property name for the OSS access key ID
static int	DEFAULT_ECS_SESSION_TOKEN_DURATION_SECONDS AK/SK expiration time obtained from ECS Metadata Service, default 6 hours
static int	DEFAULT_EXPIRED_DURATION_SECONDS Default expiration time
static double	DEFAULT_EXPIRED_FACTOR Default expiration time adjustment factor
static int	DEFAULT_HTTP_SOCKET_TIMEOUT_IN_MILLISECONDS Connection timeout when getting AK/SK, the default 5 seconds
static String	DEFAULT_PROFILE_PATH Credential profile file at the default location
static String	DEFAULT_SECTION_NAME Default section name in the profile file
static int	DEFAULT_STS_SESSION_TOKEN_DURATION_SECONDS AK/SK expire time obtained from STS, default 1 hour
static int	MAX_ECS_METADATA_FETCH_RETRY_TIMES The maximum number of retries when getting AK/SK from ECS
static String	OSS_ACCESS_KEY_ID Property name for specifying the OSS Access Key
static String	OSS_SECRET_ACCESS_KEY Property name for specifying the OSS Secret Access Key
static String	OSS_SESSION_TOKEN Property name for specifying the OSS Session Token
static String	SECRET_KEY_ENV_VAR Environment variable name for the oss secret key
static String	SECRET_KEY_SYSTEM_PROPERTY System property name for the OSS secret key
static String	SESSION_TOKEN_ENV_VAR Environment variable name for the oss session token
static String	SESSION_TOKEN_SYSTEM_PROPERTY System property name for the OSS session token

Constructor Summary

Constructors

Constructor and Description
AuthUtils()

Method Summary

Methods

Modifier and Type	Method and Description
static String	defaultProfilePath() Get the default profile path.
static void	deletePublicKey(String regionId, String accessKeyId, String accessKeySecret, String publicKeyId) Delete the uploaded public key.
static List<PublicKey>	listPublicKeys(String regionId, String accessKeyId, String accessKeySecret) List the public keys that has been uploaded.
static String	loadPrivateKeyFromFile(String privateKeyPath) Load private key content from file and format.
static String	loadPublicKeyFromFile(String publicKeyPath) Load public key content from file and format.
static PublicKey	uploadPublicKey(String regionId, String accessKeyId, String accessKeySecret, String publicKey) Upload the public key of RSA key pair.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFAULT_EXPIRED_DURATION_SECONDS

public static final int DEFAULT_EXPIRED_DURATION_SECONDS

Default expiration time

See Also:

Constant Field Values

DEFAULT_EXPIRED_FACTOR

public static final double DEFAULT_EXPIRED_FACTOR

Default expiration time adjustment factor

See Also:

Constant Field Values

MAX_ECS_METADATA_FETCH_RETRY_TIMES

public static final int MAX_ECS_METADATA_FETCH_RETRY_TIMES

The maximum number of retries when getting AK/SK from ECS

See Also:

Constant Field Values

DEFAULT_ECS_SESSION_TOKEN_DURATION_SECONDS

public static final int DEFAULT_ECS_SESSION_TOKEN_DURATION_SECONDS

AK/SK expiration time obtained from ECS Metadata Service, default 6 hours

See Also:

Constant Field Values

DEFAULT_STS_SESSION_TOKEN_DURATION_SECONDS

public static final int DEFAULT_STS_SESSION_TOKEN_DURATION_SECONDS

AK/SK expire time obtained from STS, default 1 hour

See Also:

Constant Field Values

DEFAULT_HTTP_SOCKET_TIMEOUT_IN_MILLISECONDS

public static final int DEFAULT_HTTP_SOCKET_TIMEOUT_IN_MILLISECONDS

Connection timeout when getting AK/SK, the default 5 seconds

See Also:

Constant Field Values

ACCESS_KEY_ENV_VAR

public static final String ACCESS_KEY_ENV_VAR

Environment variable name for the oss access key ID

See Also:

Constant Field Values

SECRET_KEY_ENV_VAR

public static final String SECRET_KEY_ENV_VAR

Environment variable name for the oss secret key

See Also:

Constant Field Values

SESSION_TOKEN_ENV_VAR

public static final String SESSION_TOKEN_ENV_VAR

Environment variable name for the oss session token

See Also:

Constant Field Values

ACCESS_KEY_SYSTEM_PROPERTY

public static final String ACCESS_KEY_SYSTEM_PROPERTY

System property name for the OSS access key ID

See Also:

Constant Field Values

SECRET_KEY_SYSTEM_PROPERTY

public static final String SECRET_KEY_SYSTEM_PROPERTY

System property name for the OSS secret key

See Also:

Constant Field Values

SESSION_TOKEN_SYSTEM_PROPERTY

public static final String SESSION_TOKEN_SYSTEM_PROPERTY

System property name for the OSS session token

See Also:

Constant Field Values

DEFAULT_PROFILE_PATH

public static final String DEFAULT_PROFILE_PATH

Credential profile file at the default location

DEFAULT_SECTION_NAME

public static final String DEFAULT_SECTION_NAME

Default section name in the profile file

See Also:

Constant Field Values

OSS_ACCESS_KEY_ID

public static final String OSS_ACCESS_KEY_ID

Property name for specifying the OSS Access Key

See Also:

Constant Field Values

OSS_SECRET_ACCESS_KEY

public static final String OSS_SECRET_ACCESS_KEY

Property name for specifying the OSS Secret Access Key

See Also:

Constant Field Values

OSS_SESSION_TOKEN

public static final String OSS_SESSION_TOKEN

Property name for specifying the OSS Session Token

See Also:

Constant Field Values

Constructor Detail

AuthUtils

public AuthUtils()

Method Detail

defaultProfilePath

public static String defaultProfilePath()

Get the default profile path.

Returns:

Default profile path

uploadPublicKey

public static PublicKey uploadPublicKey(String regionId,
                        String accessKeyId,
                        String accessKeySecret,
                        String publicKey)
                                 throws com.aliyuncs.exceptions.ClientException

Upload the public key of RSA key pair.

Parameters:

regionId - RAM's available area.

accessKeyId - Access Key ID of the root user.

accessKeySecret - Secret Access Key of the root user.

publicKey - Public key content.

Returns:

Public key description, include public key id etc.

Throws:

com.aliyuncs.exceptions.ClientException

listPublicKeys

public static List<PublicKey> listPublicKeys(String regionId,
                             String accessKeyId,
                             String accessKeySecret)
                                      throws com.aliyuncs.exceptions.ClientException

List the public keys that has been uploaded.

Parameters:

regionId - RAM's available area.

accessKeyId - Access Key ID of the root user.

accessKeySecret - Secret Access Key of the root user.

Returns:

Public keys.

Throws:

com.aliyuncs.exceptions.ClientException

deletePublicKey

public static void deletePublicKey(String regionId,
                   String accessKeyId,
                   String accessKeySecret,
                   String publicKeyId)
                            throws com.aliyuncs.exceptions.ClientException

Delete the uploaded public key.

Parameters:

regionId - RAM's available area.

accessKeyId - Access Key ID of the root user.

accessKeySecret - Secret Access Key of the root user.

publicKeyId - Public Key Id.

Throws:

com.aliyuncs.exceptions.ClientException

loadPublicKeyFromFile

public static String loadPublicKeyFromFile(String publicKeyPath)
                                    throws IOException

Load public key content from file and format.

Parameters:

publicKeyPath - Public key file path.

Returns:

Formatted public key content.

Throws:

IOException

loadPrivateKeyFromFile

public static String loadPrivateKeyFromFile(String privateKeyPath)
                                     throws IOException

Load private key content from file and format.

Parameters:

privateKeyPath - Private key file path.

Returns:

Formatted private key content.

Throws:

IOException