Added in API level 1

Security

class Security

kotlin.Any
↳	java.security.Security

This class centralizes all security properties and common security methods. One of its primary uses is to manage providers.

The default values of security properties are read from an implementation-specific location, which is typically the properties file lib/security/java.security in the Java installation directory.

Summary

Public methods
static Int	`addProvider(provider: Provider!)` Adds a provider to the next position available.
static String!	`getAlgorithmProperty(algName: String!, propName: String!)` Gets a specified property for an algorithm.
static MutableSet<String!>!	`getAlgorithms(serviceName: String!)` Returns a Set of Strings containing the names of all available algorithms or types for the specified Java cryptographic service (e.g., Signature, MessageDigest, Cipher, Mac, KeyStore).
static String!	`getProperty(key: String!)` Gets a security property value.
static Provider!	`getProvider(name: String!)` Returns the provider installed with the specified name, if any.
static Array<Provider!>!	`getProviders()` Returns an array containing all the installed providers.
static Array<Provider!>!	`getProviders(filter: String!)` Returns an array containing all installed providers that satisfy the specified selection criterion, or null if no such providers have been installed.
static Array<Provider!>!	`getProviders(filter: MutableMap<String!, String!>!)` Returns an array containing all installed providers that satisfy the specified* selection criteria, or null if no such providers have been installed.
static Int	`insertProviderAt(provider: Provider!, position: Int)` Adds a new provider, at a specified position.
static Unit	`removeProvider(name: String!)` Removes the provider with the specified name.
static Unit	`setProperty(key: String!, datum: String!)` Sets a security property value.

Public methods

addProvider

Added in API level 1

static fun addProvider(provider: Provider!): Int

Adds a provider to the next position available.

If there is a security manager, the java.lang.SecurityManager#checkSecurityAccess method is called with the "insertProvider" permission target name to see if it's ok to add a new provider. If this permission check is denied, checkSecurityAccess is called again with the "insertProvider."+provider.getName() permission target name. If both checks are denied, a SecurityException is thrown.

Parameters
`provider`	Provider!: the provider to be added.

Return
`Int`	the preference position in which the provider was added, or -1 if the provider was not added because it is already installed.

Exceptions
`java.lang.NullPointerException`	if provider is null
`java.lang.SecurityException`	if a security manager exists and its `java.lang.SecurityManager#checkSecurityAccess` method denies access to add a new provider

See Also

getAlgorithmProperty

Added in API level 1
Deprecated in API level 15

static fun getAlgorithmProperty(
    algName: String!, 
    propName: String!
): String!

Deprecated: This method used to return the value of a proprietary property in the master file of the "SUN" Cryptographic Service Provider in order to determine how to parse algorithm-specific parameters. Use the new provider-based and algorithm-independent AlgorithmParameters and KeyFactory engine classes (introduced in the J2SE version 1.2 platform) instead.

Gets a specified property for an algorithm. The algorithm name should be a standard name. See the Java Cryptography Architecture Standard Algorithm Name Documentation for information about standard algorithm names. One possible use is by specialized algorithm parsers, which may map classes to algorithms which they understand (much like Key parsers do).

Parameters
`algName`	String!: the algorithm name.
`propName`	String!: the name of the property to get.

Return
`String!`	the value of the specified property.

getAlgorithms

Added in API level 1

static fun getAlgorithms(serviceName: String!): MutableSet<String!>!

Returns a Set of Strings containing the names of all available algorithms or types for the specified Java cryptographic service (e.g., Signature, MessageDigest, Cipher, Mac, KeyStore). Returns an empty Set if there is no provider that supports the specified service or if serviceName is null. For a complete list of Java cryptographic services, please see the Java Cryptography Architecture API Specification & Reference. Note: the returned set is immutable.

Parameters
`serviceName`	String!: the name of the Java cryptographic service (e.g., Signature, MessageDigest, Cipher, Mac, KeyStore). Note: this parameter is case-insensitive.

Return
`MutableSet<String!>!`	a Set of Strings containing the names of all available algorithms or types for the specified Java cryptographic service or an empty set if no provider supports the specified service.

getProperty

Added in API level 1

static fun getProperty(key: String!): String!

Gets a security property value.

First, if there is a security manager, its checkPermission method is called with a java.security.SecurityPermission("getProperty."+key) permission to see if it's ok to retrieve the specified security property value..

Parameters
`key`	String!: the key of the property being retrieved.

Return
`String!`	the value of the security property corresponding to key.

Exceptions
`java.lang.SecurityException`	if a security manager exists and its java.lang.SecurityManager#checkPermission method denies access to retrieve the specified security property value
`java.lang.NullPointerException`	is key is null

See Also

getProvider

Added in API level 1

static fun getProvider(name: String!): Provider!

Returns the provider installed with the specified name, if any. Returns null if no provider with the specified name is installed or if name is null.

Parameters
`name`	String!: the name of the provider to get.

Return
`Provider!`	the provider of the specified name.

See Also

#removeProvider
#addProvider

getProviders

Added in API level 1

static fun getProviders(): Array<Provider!>!

Returns an array containing all the installed providers. The order of the providers in the array is their preference order.

Return
`Array<Provider!>!`	an array of all the installed providers.

getProviders

Added in API level 1

static fun getProviders(filter: String!): Array<Provider!>!

Returns an array containing all installed providers that satisfy the specified selection criterion, or null if no such providers have been installed. The returned providers are ordered according to their preference order.

A cryptographic service is always associated with a particular algorithm or type. For example, a digital signature service is always associated with a particular algorithm (e.g., DSA), and a CertificateFactory service is always associated with a particular certificate type (e.g., X.509).

The selection criterion must be specified in one of the following two formats:

<crypto_service>.<algorithm_or_type>
The cryptographic service name must not contain any dots.

A provider satisfies the specified selection criterion iff the provider implements the specified algorithm or type for the specified cryptographic service.

For example, "CertificateFactory.X.509" would be satisfied by any provider that supplied a CertificateFactory implementation for X.509 certificates.
<crypto_service>.<algorithm_or_type> <attribute_name>:<attribute_value>
The cryptographic service name must not contain any dots. There must be one or more space characters between the <algorithm_or_type> and the <attribute_name>.

A provider satisfies this selection criterion iff the provider implements the specified algorithm or type for the specified cryptographic service and its implementation meets the constraint expressed by the specified attribute name/value pair.

For example, "Signature.SHA1withDSA KeySize:1024" would be satisfied by any provider that implemented the SHA1withDSA signature algorithm with a keysize of 1024 (or larger).

See the Java Cryptography Architecture Standard Algorithm Name Documentation for information about standard cryptographic service names, standard algorithm names and standard attribute names.

Parameters
`filter`	String!: the criterion for selecting providers. The filter is case-insensitive.

Return
`Array<Provider!>!`	all the installed providers that satisfy the selection criterion, or null if no such providers have been installed.

Exceptions
`java.security.InvalidParameterException`	if the filter is not in the required format
`java.lang.NullPointerException`	if filter is null

See Also

#getProviders(java.util.Map)

getProviders

Added in API level 1

static fun getProviders(filter: MutableMap<String!, String!>!): Array<Provider!>!

Returns an array containing all installed providers that satisfy the specified* selection criteria, or null if no such providers have been installed. The returned providers are ordered according to their preference order.

The selection criteria are represented by a map. Each map entry represents a selection criterion. A provider is selected iff it satisfies all selection criteria. The key for any entry in such a map must be in one of the following two formats:

<crypto_service>.<algorithm_or_type>
The cryptographic service name must not contain any dots.

The value associated with the key must be an empty string.

A provider satisfies this selection criterion iff the provider implements the specified algorithm or type for the specified cryptographic service.
<crypto_service>. <algorithm_or_type> <attribute_name>
The cryptographic service name must not contain any dots. There must be one or more space characters between the <algorithm_or_type> and the <attribute_name>.

The value associated with the key must be a non-empty string. A provider satisfies this selection criterion iff the provider implements the specified algorithm or type for the specified cryptographic service and its implementation meets the constraint expressed by the specified attribute name/value pair.

See the Java Cryptography Architecture Standard Algorithm Name Documentation for information about standard cryptographic service names, standard algorithm names and standard attribute names.

Parameters
`filter`	MutableMap<String!, String!>!: the criteria for selecting providers. The filter is case-insensitive.

Return
`Array<Provider!>!`	all the installed providers that satisfy the selection criteria, or null if no such providers have been installed.

Exceptions
`java.security.InvalidParameterException`	if the filter is not in the required format
`java.lang.NullPointerException`	if filter is null

See Also

#getProviders(java.lang.String)

insertProviderAt

Added in API level 1

static fun insertProviderAt(
    provider: Provider!, 
    position: Int
): Int

Adds a new provider, at a specified position. The position is the preference order in which providers are searched for requested algorithms. The position is 1-based, that is, 1 is most preferred, followed by 2, and so on.

If the given provider is installed at the requested position, the provider that used to be at that position, and all providers with a position greater than position, are shifted up one position (towards the end of the list of installed providers).

A provider cannot be added if it is already installed.

Parameters
`provider`	Provider!: the provider to be added.
`position`	Int: the preference position that the caller would like for this provider.

Return
`Int`	the actual preference position in which the provider was added, or -1 if the provider was not added because it is already installed.

Exceptions
`java.lang.NullPointerException`	if provider is null
`java.lang.SecurityException`	if a security manager exists and its `java.lang.SecurityManager#checkSecurityAccess` method denies access to add a new provider

See Also

removeProvider

Added in API level 1

static fun removeProvider(name: String!): Unit

Removes the provider with the specified name.

When the specified provider is removed, all providers located at a position greater than where the specified provider was are shifted down one position (towards the head of the list of installed providers).

This method returns silently if the provider is not installed or if name is null.

First, if there is a security manager, its checkSecurityAccess method is called with the string "removeProvider."+name to see if it's ok to remove the provider. If the default implementation of checkSecurityAccess is used (i.e., that method is not overriden), then this will result in a call to the security manager's checkPermission method with a SecurityPermission("removeProvider."+name) permission.

Parameters
`name`	String!: the name of the provider to remove.

Exceptions
`java.lang.SecurityException`	if a security manager exists and its `java.lang.SecurityManager#checkSecurityAccess` method denies access to remove the provider

See Also

#getProvider
#addProvider

setProperty

Added in API level 1

static fun setProperty(
    key: String!, 
    datum: String!
): Unit

Sets a security property value.

First, if there is a security manager, its checkPermission method is called with a java.security.SecurityPermission("setProperty."+key) permission to see if it's ok to set the specified security property value.

Parameters
`key`	String!: the name of the property to be set.
`datum`	String!: the value of the property to be set.

Exceptions
`java.lang.SecurityException`	if a security manager exists and its java.lang.SecurityManager#checkPermission method denies access to set the specified security property value
`java.lang.NullPointerException`	if key or datum is null

See Also