java.security
Class Security

java.lang.Object
  |
  +--java.security.Security

public final class Security
extends Object

Untamed:

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

Version:
1.117, 04/19/02
Author:
Benjamin Renaud

Field Summary
(package private) static boolean debug
           
private static Hashtable engineCache
           
(package private) static boolean error
           
private static int indexStaticProviders
           
private static int numOfStaticProviders
           
private static Properties props
           
private static Hashtable providerLoads
           
private static Vector providerMasterClassNames
           
private static Hashtable providerPropertiesCache
           
private static Vector providers
           
private static boolean reloadProviders
           
private static boolean resetProviderIndex
           
private static sun.security.util.Debug sdebug
           
private static Hashtable searchResultsCache
           
 
Constructor Summary
private Security()
          Don't let anyone instantiate this.
 
Method Summary
static int addProvider(Provider provider)
          Enabled: Adds a provider to the next position available.
private static void check(String directive)
           
private static boolean checkSuperclass(Class subclass, Class superclass)
           
private static void countProviders()
          Loops through provider declarations, which are expected to be of the form: security.provider.1=sun.security.provider.Sun security.provider.2=sun.security.jsafe.Jsafe etc.
(package private) static void debug(String msg)
          Print an debugging message that may be significant to a developer.
(package private) static void debug(String msg, Throwable t)
          Print an debugging message that may be significant to a developer.
private static Object[] doGetImpl(String algorithm, String type, java.security.Security.ProviderProperty pp)
           
private static Object[] doGetImpl(String algorithm, String type, java.security.Security.ProviderProperty pp, Object params)
           
(package private) static void error(String msg)
          Print an error message that may be significant to a user.
(package private) static void error(String msg, Throwable t)
          Print an error message that may be significant to a user.
static String getAlgorithmProperty(String algName, String propName)
          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 Java 2 platform) instead.
static Set getAlgorithms(String serviceName)
          Enabled: 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).
private static LinkedHashSet getAllQualifyingCandidates(String filterKey, String filterValue, Provider[] allProviders)
           
private static java.security.Security.ProviderProperty getEngineClassName(String algName, Provider provider, String engineType)
          The parameter provider cannot be null.
private static java.security.Security.ProviderProperty getEngineClassName(String algName, String engineType)
           
private static java.security.Security.ProviderProperty getEngineClassName(String algName, String provider, String engineType)
           
(package private) static String[] getFilterComponents(String filterKey, String filterValue)
           
(package private) static Object[] getImpl(String algorithm, String type, Provider provider)
           
(package private) static Object[] getImpl(String algorithm, String type, Provider provider, Object params)
           
(package private) static Object[] getImpl(String algorithm, String type, String provider)
           
(package private) static Object[] getImpl(String algorithm, String type, String provider, Object params)
           
static String getProperty(String key)
          Enabled: Gets a security property value.
static Provider getProvider(String name)
          Enabled: Returns the provider installed with the specified name, if any.
private static java.security.Security.ProviderProperty getProviderProperty(String key)
          Looks up providers, and returns the property (and its associated provider) mapping the key, if any.
private static String getProviderProperty(String key, Provider provider)
          Returns the property (if any) mapping the key for the given provider.
static Provider[] getProviders()
          Enabled: Returns an array containing all the installed providers.
static Provider[] getProviders(Map filter)
          Enabled: Returns an array containing all installed providers that satisfy the specified selection criteria, or null if no such providers have been installed.
static Provider[] getProviders(String filter)
          Enabled: Returns an array containing all installed providers that satisfy the specified selection criterion, or null if no such providers have been installed.
private static LinkedHashSet getProvidersNotUsingCache(String serviceName, String algName, String attrName, String filterValue, LinkedHashSet candidates, Provider[] allProviders)
           
private static String getStandardName(String alias, String engineType, Provider prov)
          We always map names to standard names
private static void initialize()
           
private static void initializeStatic()
           
static int insertProviderAt(Provider provider, int position)
          Enabled: Adds a new provider, at a specified position.
private static void invalidateSMCache(String key)
           
private static boolean isConstraintSatisfied(String attribute, String value, String prop)
           
private static boolean isCriterionSatisfied(Provider prov, String serviceName, String algName, String attrName, String filterValue)
           
private static boolean isStandardAttr(String attribute)
           
private static void loadOneMoreProvider()
          Try our best to load one more statically registered provider.
private static void reloadProviders()
           
static void removeProvider(String name)
          Enabled: Removes the provider with the specified name.
private static File securityPropFile(String filename)
           
static void setProperty(String key, String datum)
          Enabled: Sets a security property value.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

reloadProviders

private static boolean reloadProviders

debug

static final boolean debug

sdebug

private static final sun.security.util.Debug sdebug

error

static final boolean error

props

private static Properties props

providers

private static Vector providers

providerPropertiesCache

private static Hashtable providerPropertiesCache

engineCache

private static Hashtable engineCache

searchResultsCache

private static Hashtable searchResultsCache

providerLoads

private static Hashtable providerLoads

numOfStaticProviders

private static int numOfStaticProviders

providerMasterClassNames

private static Vector providerMasterClassNames

indexStaticProviders

private static int indexStaticProviders

resetProviderIndex

private static boolean resetProviderIndex
Constructor Detail

Security

private Security()
Don't let anyone instantiate this.

Method Detail

initialize

private static void initialize()

initializeStatic

private static void initializeStatic()

countProviders

private static void countProviders()
Loops through provider declarations, which are expected to be of the form: security.provider.1=sun.security.provider.Sun security.provider.2=sun.security.jsafe.Jsafe etc. The order determines the default search order when looking for an algorithm.


reloadProviders

private static void reloadProviders()

loadOneMoreProvider

private static void loadOneMoreProvider()
Try our best to load one more statically registered provider. This is used by getEngineClassName(String algName, String engineType).


securityPropFile

private static File securityPropFile(String filename)

getProviderProperty

private static java.security.Security.ProviderProperty getProviderProperty(String key)
Looks up providers, and returns the property (and its associated provider) mapping the key, if any. The order in which the providers are looked up is the provider-preference order, as specificed in the security properties file.


getProviderProperty

private static String getProviderProperty(String key,
                                          Provider provider)
Returns the property (if any) mapping the key for the given provider.


getStandardName

private static String getStandardName(String alias,
                                      String engineType,
                                      Provider prov)
We always map names to standard names


getAlgorithmProperty

public static String getAlgorithmProperty(String algName,
                                          String propName)
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 Java 2 platform) instead.

Enabled: Gets a specified property for an algorithm. The algorithm name should be a standard name. See Appendix A in the Java Cryptography Architecture API Specification & Reference 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.

getEngineClassName

private static java.security.Security.ProviderProperty getEngineClassName(String algName,
                                                                          String engineType)
                                                                   throws NoSuchAlgorithmException
NoSuchAlgorithmException

getEngineClassName

private static java.security.Security.ProviderProperty getEngineClassName(String algName,
                                                                          String provider,
                                                                          String engineType)
                                                                   throws NoSuchAlgorithmException,
                                                                          NoSuchProviderException
NoSuchAlgorithmException
NoSuchProviderException

getEngineClassName

private static java.security.Security.ProviderProperty getEngineClassName(String algName,
                                                                          Provider provider,
                                                                          String engineType)
                                                                   throws NoSuchAlgorithmException
The parameter provider cannot be null.

NoSuchAlgorithmException

insertProviderAt

public static int insertProviderAt(Provider provider,
                                   int position)
Enabled: 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.
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:
SecurityException - if a security manager exists and its java.lang.SecurityManager#checkSecurityAccess method denies access to add a new provider
See Also:
getProvider(java.lang.String), removeProvider(java.lang.String), java.security.SecurityPermission

addProvider

public static int addProvider(Provider provider)
Enabled: 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.
Returns:
the preference position in which the provider was added, or -1 if the provider was not added because it is already installed.
Throws:
SecurityException - if a security manager exists and its java.lang.SecurityManager#checkSecurityAccess method denies access to add a new provider
See Also:
getProvider(java.lang.String), removeProvider(java.lang.String), java.security.SecurityPermission

removeProvider

public static void removeProvider(String name)
Enabled: 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 method denies access to remove the provider
See Also:
getProvider(java.lang.String), addProvider(java.security.Provider)

getProviders

public static Provider[] getProviders()
Enabled: 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.

getProvider

public static Provider getProvider(String name)
Enabled: 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.
Returns:
the provider of the specified name.
See Also:
removeProvider(java.lang.String), addProvider(java.security.Provider)

getProviders

public static Provider[] getProviders(String filter)
Enabled: 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:

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 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 - if the filter is not in the required format
See Also:
getProviders(java.util.Map)

getProviders

public static Provider[] getProviders(Map filter)
Enabled: 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:

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 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 - if the filter is not in the required format
See Also:
getProviders(java.lang.String)

checkSuperclass

private static boolean checkSuperclass(Class subclass,
                                       Class superclass)

getImpl

static Object[] getImpl(String algorithm,
                        String type,
                        String provider)
                 throws NoSuchAlgorithmException,
                        NoSuchProviderException
NoSuchAlgorithmException
NoSuchProviderException

getImpl

static Object[] getImpl(String algorithm,
                        String type,
                        String provider,
                        Object params)
                 throws NoSuchAlgorithmException,
                        NoSuchProviderException,
                        InvalidAlgorithmParameterException
NoSuchAlgorithmException
NoSuchProviderException
InvalidAlgorithmParameterException

getImpl

static Object[] getImpl(String algorithm,
                        String type,
                        Provider provider)
                 throws NoSuchAlgorithmException
NoSuchAlgorithmException

getImpl

static Object[] getImpl(String algorithm,
                        String type,
                        Provider provider,
                        Object params)
                 throws NoSuchAlgorithmException,
                        InvalidAlgorithmParameterException
NoSuchAlgorithmException
InvalidAlgorithmParameterException

doGetImpl

private static Object[] doGetImpl(String algorithm,
                                  String type,
                                  java.security.Security.ProviderProperty pp)
                           throws NoSuchAlgorithmException
NoSuchAlgorithmException

doGetImpl

private static Object[] doGetImpl(String algorithm,
                                  String type,
                                  java.security.Security.ProviderProperty pp,
                                  Object params)
                           throws NoSuchAlgorithmException,
                                  InvalidAlgorithmParameterException
NoSuchAlgorithmException
InvalidAlgorithmParameterException

getProperty

public static String getProperty(String key)
Enabled: 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 - if a security manager exists and its java.lang.SecurityManager#checkPermission method denies access to retrieve the specified security property value
See Also:
setProperty(java.lang.String, java.lang.String), java.security.SecurityPermission

setProperty

public static void setProperty(String key,
                               String datum)
Enabled: 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 - if a security manager exists and its java.lang.SecurityManager#checkPermission method denies access to set the specified security property value
See Also:
getProperty(java.lang.String), java.security.SecurityPermission

invalidateSMCache

private static void invalidateSMCache(String key)

check

private static void check(String directive)

error

static void error(String msg)
Print an error message that may be significant to a user.


error

static void error(String msg,
                  Throwable t)
Print an error message that may be significant to a user.


debug

static void debug(String msg)
Print an debugging message that may be significant to a developer.


debug

static void debug(String msg,
                  Throwable t)
Print an debugging message that may be significant to a developer.


getAllQualifyingCandidates

private static LinkedHashSet getAllQualifyingCandidates(String filterKey,
                                                        String filterValue,
                                                        Provider[] allProviders)

getProvidersNotUsingCache

private static LinkedHashSet getProvidersNotUsingCache(String serviceName,
                                                       String algName,
                                                       String attrName,
                                                       String filterValue,
                                                       LinkedHashSet candidates,
                                                       Provider[] allProviders)

isCriterionSatisfied

private static boolean isCriterionSatisfied(Provider prov,
                                            String serviceName,
                                            String algName,
                                            String attrName,
                                            String filterValue)

isStandardAttr

private static boolean isStandardAttr(String attribute)

isConstraintSatisfied

private static boolean isConstraintSatisfied(String attribute,
                                             String value,
                                             String prop)

getFilterComponents

static String[] getFilterComponents(String filterKey,
                                    String filterValue)

getAlgorithms

public static Set getAlgorithms(String serviceName)
Enabled: 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.
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.
Since:
1.4


comments?