# Security

public final class **Security** extends [Object](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html)  
<br />

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.

### Public Method Summary

|---|---|
| static int | [addProvider](https://developers.google.com/j2objc/javadoc/jre/reference/java/security/Security.html#addProvider(java.security.Provider))([Provider](https://developers.google.com/j2objc/javadoc/jre/reference/java/security/Provider.html) provider) Adds a provider to the next position available. |
| static [String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html) | [getAlgorithmProperty](https://developers.google.com/j2objc/javadoc/jre/reference/java/security/Security.html#getAlgorithmProperty(java.lang.String,%20java.lang.String))([String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html) algName, [String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html) propName) *This method is 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.* |
| static [Set](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Set.html)\<[String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html)\> | [getAlgorithms](https://developers.google.com/j2objc/javadoc/jre/reference/java/security/Security.html#getAlgorithms(java.lang.String))([String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html) serviceName) 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](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html) | [getProperty](https://developers.google.com/j2objc/javadoc/jre/reference/java/security/Security.html#getProperty(java.lang.String))([String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html) key) Gets a security property value. |
| static [Provider](https://developers.google.com/j2objc/javadoc/jre/reference/java/security/Provider.html) | [getProvider](https://developers.google.com/j2objc/javadoc/jre/reference/java/security/Security.html#getProvider(java.lang.String))([String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html) name) Returns the provider installed with the specified name, if any. |
| static [Provider\[\]](https://developers.google.com/j2objc/javadoc/jre/reference/java/security/Provider.html) | [getProviders](https://developers.google.com/j2objc/javadoc/jre/reference/java/security/Security.html#getProviders(java.util.Map<java.lang.String,%20java.lang.String>))([Map](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Map.html)\<[String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html), [String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html)\> filter) Returns an array containing all installed providers that satisfy the specified\* selection criteria, or null if no such providers have been installed. |
| static [Provider\[\]](https://developers.google.com/j2objc/javadoc/jre/reference/java/security/Provider.html) | [getProviders](https://developers.google.com/j2objc/javadoc/jre/reference/java/security/Security.html#getProviders())() Returns an array containing all the installed providers. |
| static [Provider\[\]](https://developers.google.com/j2objc/javadoc/jre/reference/java/security/Provider.html) | [getProviders](https://developers.google.com/j2objc/javadoc/jre/reference/java/security/Security.html#getProviders(java.lang.String))([String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html) filter) Returns an array containing all installed providers that satisfy the specified selection criterion, or null if no such providers have been installed. |
| synchronized static int | [insertProviderAt](https://developers.google.com/j2objc/javadoc/jre/reference/java/security/Security.html#insertProviderAt(java.security.Provider,%20int))([Provider](https://developers.google.com/j2objc/javadoc/jre/reference/java/security/Provider.html) provider, int position) Adds a new provider, at a specified position. |
| synchronized static void | [removeProvider](https://developers.google.com/j2objc/javadoc/jre/reference/java/security/Security.html#removeProvider(java.lang.String))([String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html) name) Removes the provider with the specified name. |
| static void | [setProperty](https://developers.google.com/j2objc/javadoc/jre/reference/java/security/Security.html#setProperty(java.lang.String,%20java.lang.String))([String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html) key, [String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html) datum) Sets a security property value. |

### Inherited Method Summary

From class [java.lang.Object](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html)

|---|---|
| [Object](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html) | [clone](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#clone())() Creates and returns a copy of this `Object`. |
| boolean | [equals](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#equals(java.lang.Object))([Object](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html) obj) Compares this instance with the specified object and indicates if they are equal. |
| void | [finalize](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#finalize())() Invoked when the garbage collector has detected that this instance is no longer reachable. |
| final [Class](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Class.html)\<?\> | [getClass](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#getClass())() Returns the unique instance of `https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Class.html` that represents this object's class. |
| int | [hashCode](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#hashCode())() Returns an integer hash code for this object. |
| final void | [notify](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#notify())() Causes a thread which is waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up. |
| final void | [notifyAll](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#notifyAll())() Causes all threads which are waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up. |
| [String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html) | [toString](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#toString())() Returns a string containing a concise, human-readable description of this object. |
| final void | [wait](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#wait(long,%20int))(long timeout, int nanos) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires. |
| final void | [wait](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#wait(long))(long timeout) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires. |
| final void | [wait](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#wait())() Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object. |

## Public Methods

#### public static int
**addProvider**
([Provider](https://developers.google.com/j2objc/javadoc/jre/reference/java/security/Provider.html) provider)

Adds a provider to the next position available.

If there is a security manager, the
`https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/SecurityManager.html#checkSecurityAccess(java.lang.String)` 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 | the provider to be added. |
|---|---|

##### Returns

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

##### Throws

| [NullPointerException](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/NullPointerException.html) | if provider is null |
| [SecurityException](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/SecurityException.html) | if a security manager exists and its `https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/SecurityManager.html#checkSecurityAccess(java.lang.String)` method denies access to add a new provider |
|---|---|

##### See Also

- `https://developers.google.com/j2objc/javadoc/jre/reference/java/security/Security.html#getProvider(java.lang.String)`
- `https://developers.google.com/j2objc/javadoc/jre/reference/java/security/Security.html#removeProvider(java.lang.String)`
- `https://developers.google.com/j2objc/javadoc/jre/reference/java/security/SecurityPermission.html`

#### public static [String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html)
**getAlgorithmProperty**
([String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html) algName, [String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html) propName)


**This method is 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](https://developers.google.com/j2objc/javadoc/jre/technotes/guides/security/StandardNames.html)
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 | the algorithm name. |
| propName | the name of the property to get. |
|---|---|

##### Returns

- the value of the specified property.

#### public static [Set](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Set.html)\<[String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html)\>
**getAlgorithms**
([String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html) serviceName)

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](https://developers.google.com/j2objc/javadoc/jre/technotes/guides/security/crypto/CryptoSpec.html).
Note: the returned set is immutable.

##### Parameters

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

##### Returns

- 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.

#### public static [String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html)
**getProperty**
([String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html) key)

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 | the key of the property being retrieved. |
|---|---|

##### Returns

- the value of the security property corresponding to key.

##### Throws

| [SecurityException](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/SecurityException.html) | if a security manager exists and its `https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/SecurityManager.html#checkPermission(java.security.Permission)` method denies access to retrieve the specified security property value |
| [NullPointerException](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/NullPointerException.html) | is key is null |
|---|---|

##### See Also

- `https://developers.google.com/j2objc/javadoc/jre/reference/java/security/Security.html#setProperty(java.lang.String,%20java.lang.String)`
- `https://developers.google.com/j2objc/javadoc/jre/reference/java/security/SecurityPermission.html`

#### public static [Provider](https://developers.google.com/j2objc/javadoc/jre/reference/java/security/Provider.html)
**getProvider**
([String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html) name)

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 | the name of the provider to get. |
|---|---|

##### Returns

- the provider of the specified name.

##### See Also

- `https://developers.google.com/j2objc/javadoc/jre/reference/java/security/Security.html#removeProvider(java.lang.String)`
- `https://developers.google.com/j2objc/javadoc/jre/reference/java/security/Security.html#addProvider(java.security.Provider)`

#### public static [Provider\[\]](https://developers.google.com/j2objc/javadoc/jre/reference/java/security/Provider.html)
**getProviders**
([Map](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Map.html)\<[String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html), [String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html)\> filter)

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
{@linkplain #insertProviderAt(java.security.Provider, int)
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](https://developers.google.com/j2objc/javadoc/jre/technotes/guides/security/StandardNames.html)
for information about standard cryptographic service names, standard
algorithm names and standard attribute names.

##### Parameters

| filter | the criteria for selecting providers. The filter is case-insensitive. |
|---|---|

##### Returns

- all the installed providers that satisfy the selection criteria, or null if no such providers have been installed.

##### Throws

| [InvalidParameterException](https://developers.google.com/j2objc/javadoc/jre/reference/java/security/InvalidParameterException.html) | if the filter is not in the required format |
| [NullPointerException](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/NullPointerException.html) | if filter is null |
|---|---|

##### See Also

- `https://developers.google.com/j2objc/javadoc/jre/reference/java/security/Security.html#getProviders(java.lang.String)`

#### public static [Provider\[\]](https://developers.google.com/j2objc/javadoc/jre/reference/java/security/Provider.html)
**getProviders**
()

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

##### Returns

- an array of all the installed providers.

#### public static [Provider\[\]](https://developers.google.com/j2objc/javadoc/jre/reference/java/security/Provider.html)
**getProviders**
([String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html) filter)

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
{@linkplain #insertProviderAt(java.security.Provider, int) 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](https://developers.google.com/j2objc/javadoc/jre/technotes/guides/security/StandardNames.html)
for information about standard cryptographic service names, standard
algorithm names and standard attribute names.

##### Parameters

| filter | the criterion for selecting providers. The filter is case-insensitive. |
|---|---|

##### Returns

- all the installed providers that satisfy the selection criterion, or null if no such providers have been installed.

##### Throws

| [InvalidParameterException](https://developers.google.com/j2objc/javadoc/jre/reference/java/security/InvalidParameterException.html) | if the filter is not in the required format |
| [NullPointerException](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/NullPointerException.html) | if filter is null |
|---|---|

##### See Also

- `https://developers.google.com/j2objc/javadoc/jre/reference/java/security/Security.html#getProviders(java.util.Map<java.lang.String,%20java.lang.String>)`

#### public static synchronized int
**insertProviderAt**
([Provider](https://developers.google.com/j2objc/javadoc/jre/reference/java/security/Provider.html) provider, int position)

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.

If there is a security manager, the
`https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/SecurityManager.html#checkSecurityAccess(java.lang.String)` 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 | the provider to be added. |
| position | the preference position that the caller would like for this provider. |
|---|---|

##### Returns

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

##### Throws

| [NullPointerException](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/NullPointerException.html) | if provider is null |
| [SecurityException](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/SecurityException.html) | if a security manager exists and its `https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/SecurityManager.html#checkSecurityAccess(java.lang.String)` method denies access to add a new provider |
|---|---|

##### See Also

- `https://developers.google.com/j2objc/javadoc/jre/reference/java/security/Security.html#getProvider(java.lang.String)`
- `https://developers.google.com/j2objc/javadoc/jre/reference/java/security/Security.html#removeProvider(java.lang.String)`
- `https://developers.google.com/j2objc/javadoc/jre/reference/java/security/SecurityPermission.html`

#### public static synchronized void
**removeProvider**
([String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html) name)

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 | the name of the provider to remove. |
|---|---|

##### Throws

| [SecurityException](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/SecurityException.html) | if a security manager exists and its `https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/SecurityManager.html#checkSecurityAccess(java.lang.String)` method denies access to remove the provider |
|---|---|

##### See Also

- `https://developers.google.com/j2objc/javadoc/jre/reference/java/security/Security.html#getProvider(java.lang.String)`
- `https://developers.google.com/j2objc/javadoc/jre/reference/java/security/Security.html#addProvider(java.security.Provider)`

#### public static void
**setProperty**
([String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html) key, [String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html) datum)

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 | the name of the property to be set. |
| datum | the value of the property to be set. |
|---|---|

##### Throws

| [SecurityException](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/SecurityException.html) | if a security manager exists and its `https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/SecurityManager.html#checkPermission(java.security.Permission)` method denies access to set the specified security property value |
| [NullPointerException](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/NullPointerException.html) | if key or datum is null |
|---|---|

##### See Also

- `https://developers.google.com/j2objc/javadoc/jre/reference/java/security/Security.html#getProperty(java.lang.String)`
- `https://developers.google.com/j2objc/javadoc/jre/reference/java/security/SecurityPermission.html`