| java.lang.Object
 java.security.Security
| Security | | final public class Security (Code) | | This class centralizes all security properties and common security
methods. One of its primary uses is to manage providers.
author:
Benjamin Renaud
version:
1.101 10/17/00 |
| Field Summary | |
| final static boolean | debug
| | final static boolean | error
|
| Method Summary | |
| public static int | addProvider(Provider provider)
Adds a provider to the next position available.
First, if there is a security manager, its
checkSecurityAccess
method is called with the string
"insertProvider."+provider.getName()
to see if it's ok to add a new provider. | | static void | debug(String msg)
Print an debugging message that may be significant to a developer. | | static void | debug(String msg, Throwable t)
Print an debugging message that may be significant to a developer. | | static void | error(String msg)
Print an error message that may be significant to a user. | | static void | error(String msg, Throwable t)
Print an error message that may be significant to a user. | | public static Set | getAlgorithms(String 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[] | getFilterComponents(String filterKey, String filterValue)
| | static Object[] | getImpl(String algorithm, String type, String provider)
| | static Object[] | getImpl(String algorithm, String type, String provider, Object params)
| | static Object[] | getImpl(String algorithm, String type, Provider provider)
| | static Object[] | getImpl(String algorithm, String type, Provider provider, Object params)
| | public static String | getProperty(String 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.. | | public static synchronized Provider | getProvider(String name)
Returns the provider installed with the specified name, if
any. | | public static synchronized Provider[] | getProviders()
Returns an array containing all the installed providers. | | public static Provider[] | getProviders(String filter)
Returns an array containing all installed providers that satisfy the
specified selection criterion, or null if no such providers have been
installed. | | public static Provider[] | getProviders(Map filter)
Returns an array containing all installed providers that satisfy the specified
selection criteria, or null if no such providers have been installed. | | public static synchronized int | insertProviderAt(Provider provider, int position)
Adds a new provider, at a specified position. | | public static synchronized void | removeProvider(String 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.
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. | | public static void | setProperty(String key, String datum)
Sets a security property value. |
| debug | | final static boolean debug(Code) | | |
| error | | final static boolean error(Code) | | |
| addProvider | | public static int addProvider(Provider provider)(Code) | | Adds a provider to the next position available.
First, if there is a security manager, its
checkSecurityAccess
method is called with the string
"insertProvider."+provider.getName()
to see if it's ok to add a new 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("insertProvider."+provider.getName())
permission.
Parameters:
provider - the provider to be added. the preference position in which the provider was added, or -1 if the provider was not added because it isalready installed.
throws:
SecurityException - if a security manager exists and its java.lang.SecurityManager.checkSecurityAccess methoddenies access to add a new provider
See Also: Security.getProvider
See Also: Security.removeProvider
See Also: java.security.SecurityPermission |
| debug | | static void debug(String msg)(Code) | | Print an debugging message that may be significant to a developer.
|
| debug | | static void debug(String msg, Throwable t)(Code) | | Print an debugging message that may be significant to a developer.
|
| error | | static void error(String msg)(Code) | | Print an error message that may be significant to a user.
|
| error | | static void error(String msg, Throwable t)(Code) | | Print an error message that may be significant to a user.
|
| getAlgorithms | | public static Set getAlgorithms(String serviceName)(Code) | | 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. 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 - the name of the Java cryptographic service (e.g., Signature, MessageDigest, Cipher, Mac, KeyStore).Note: this parameter is case-insensitive.NOTE: java.security.Signature, java.security.KeyStore are found in J2ME CDC profiles such as J2ME Foundation Profile. Cipher,Mac are found in J2ME CDC optional packages such as J2ME SecurityOptional Package. a Set of Strings containing the names of all available algorithms or types for the specified Java cryptographic serviceor an empty set if no provider supports the specified service.
since:
1.4 |
| getProperty | | public static String getProperty(String key)(Code) | | 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. the value of the security property corresponding to key.
throws:
SecurityException - if a security manager exists and its java.lang.SecurityManager.checkPermission methoddeniesaccess to retrieve the specified security property value
See Also: Security.setProperty
See Also: java.security.SecurityPermission |
| getProvider | | public static synchronized Provider getProvider(String name)(Code) | | Returns the provider installed with the specified name, if
any. Returns null if no provider with the specified name is
installed.
Parameters:
name - the name of the provider to get. the provider of the specified name.
See Also: Security.removeProvider
See Also: Security.addProvider |
| getProviders | | public static synchronized Provider[] getProviders()(Code) | | Returns an array containing all the installed providers. The order of
the providers in the array is their preference order.
an array of all the installed providers. |
| getProviders | | public static Provider[] getProviders(String filter)(Code) | | 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).
NOTE: java.security.cert.CertificateFactory is found in J2ME CDC
profiles such as J2ME Foundation Profile.
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.
NOTE: java.security.cert.CertificateFactory is found in J2ME CDC
profiles such as J2ME Foundation Profile.
- <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 charaters between the 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).
NOTE: java.security.Signature is found in J2ME CDC profiles such as
J2ME Foundation Profile.
See Appendix A in the
Java Cryptogaphy Architecture API Specification & Reference
for information about standard cryptographic service names, standard
algorithm names and standard attribute names.
Parameters:
filter - the criterion for selectingproviders. The filter is case-insensitive. all the installed providers that satisfy the selectioncriterion, or null if no such providers have been installed.
throws:
InvalidParameterException - if the filter is not in the required format
See Also: Security.getProviders(java.util.Map) |
| getProviders | | public static Provider[] getProviders(Map filter)(Code) | | 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 charaters 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 Appendix A in the
Java Cryptogaphy Architecture API Specification & Reference
for information about standard cryptographic service names, standard
algorithm names and standard attribute names.
Parameters:
filter - the criteria for selectingproviders. The filter is case-insensitive. all the installed providers that satisfy the selectioncriteria, or null if no such providers have been installed.
throws:
InvalidParameterException - if the filter is not in the required format
See Also: Security.getProviders(java.lang.String) |
| insertProviderAt | | public static synchronized int insertProviderAt(Provider provider, int position)(Code) | | Adds a new provider, at a specified position. The position is
the preference order in which providers are searched for
requested algorithms. Note that it is not guaranteed that this
preference will be respected. 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.
First, if there is a security manager, its
checkSecurityAccess
method is called with the string
"insertProvider."+provider.getName()
to see if it's ok to add a new 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("insertProvider."+provider.getName())
permission.
Parameters:
provider - the provider to be added.
Parameters:
position - the preference position that the caller wouldlike for this provider. the actual preference position in which the provider was added, or -1 if the provider was not added because it isalready installed.
throws:
SecurityException - if a security manager exists and its java.lang.SecurityManager.checkSecurityAccess methoddenies access to add a new provider
See Also: Security.getProvider
See Also: Security.removeProvider
See Also:
See Also: java.security.SecurityPermission |
| removeProvider | | public static synchronized void removeProvider(String name)(Code) | | 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.
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 - if a security manager exists and its java.lang.SecurityManager.checkSecurityAccess methoddeniesaccess to remove the provider
See Also: Security.getProvider
See Also: Security.addProvider |
| setProperty | | public static void setProperty(String key, String datum)(Code) | | 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.
Parameters:
datum - the value of the property to be set.
throws:
SecurityException - if a security manager exists and its java.lang.SecurityManager.checkPermission methoddenies access to set the specified security property value
See Also: Security.getProperty
See Also: java.security.SecurityPermission |
|
|