Class Policy
- java.lang.Object
-
- javax.security.auth.Policy
Deprecated.
as of JDK version 1.4 -- Replaced by java.security.Policy. java.security.Policy has a method:
public PermissionCollection getPermissions (java.security.ProtectionDomain pd)and ProtectionDomain has a constructor:
public ProtectionDomain (CodeSource cs, PermissionCollection permissions, ClassLoader loader, Principal[] principals)These two APIs provide callers the means to query the Policy for Principal-based Permission entries.
@Deprecated public abstract class Policy extends Object
This is an abstract class for representing the system policy for Subject-based authorization. A subclass implementation of this class provides a means to specify a Subject-based access control Policy
.
A Policy
object can be queried for the set of Permissions granted to code running as a Principal
in the following manner:
policy = Policy.getPolicy(); PermissionCollection perms = policy.getPermissions(subject, codeSource);The
Policy
object consults the local policy and returns and appropriate Permissions
object with the Permissions granted to the Principals associated with the provided subject, and granted to the code specified by the provided codeSource. A Policy
contains the following information. Note that this example only represents the syntax for the default Policy
implementation. Subclass implementations of this class may implement alternative syntaxes and may retrieve the Policy
from any source such as files, databases, or servers.
Each entry in the Policy
is represented as a grant entry. Each grant entry specifies a codebase, code signers, and Principals triplet, as well as the Permissions granted to that triplet.
grant CodeBase ["URL"], Signedby ["signers"], Principal [Principal_Class] "Principal_Name" { Permission Permission_Class ["Target_Name"] [, "Permission_Actions"] [, signedBy "SignerName"]; };The CodeBase and Signedby components of the triplet name/value pairs are optional. If they are not present, then any any codebase will match, and any signer (including unsigned code) will match. For Example,
grant CodeBase "foo.com", Signedby "foo", Principal com.sun.security.auth.SolarisPrincipal "duke" { permission java.io.FilePermission "/home/duke", "read, write"; };This grant entry specifies that code from "foo.com", signed by "foo', and running as a
SolarisPrincipal
with the name, duke, has one Permission
. This Permission
permits the executing code to read and write files in the directory, "/home/duke". To "run" as a particular Principal
, code invokes the Subject.doAs(subject, ...)
method. After invoking that method, the code runs as all the Principals associated with the specified Subject
. Note that this Policy
(and the Permissions granted in this Policy
) only become effective after the call to Subject.doAs
has occurred.
Multiple Principals may be listed within one grant entry. All the Principals in the grant entry must be associated with the Subject
provided to Subject.doAs
for that Subject
to be granted the specified Permissions.
grant Principal com.sun.security.auth.SolarisPrincipal "duke", Principal com.sun.security.auth.SolarisNumericUserPrincipal "0" { permission java.io.FilePermission "/home/duke", "read, write"; permission java.net.SocketPermission "duke.com", "connect"; };This entry grants any code running as both "duke" and "0" permission to read and write files in duke's home directory, as well as permission to make socket connections to "duke.com".
Note that non Principal-based grant entries are not permitted in this Policy
. Therefore, grant entries such as:
grant CodeBase "foo.com", Signedby "foo" { permission java.io.FilePermission "/tmp/scratch", "read, write"; };are rejected. Such permission must be listed in the
java.security.Policy
. The default Policy
implementation can be changed by setting the value of the auth.policy.provider
security property to the fully qualified name of the desired Policy
implementation class.
- See Also:
security properties
Constructors
Modifier | Constructor and Description |
---|---|
protected |
Policy() Deprecated. Sole constructor. |
Methods
Modifier and Type | Method and Description |
---|---|
abstract PermissionCollection |
getPermissions(Subject subject,
CodeSource cs) Deprecated. Retrieve the Permissions granted to the Principals associated with the specified |
static Policy |
getPolicy() Deprecated. Returns the installed Policy object. |
abstract void |
refresh() Deprecated. Refresh and reload the Policy. |
static void |
setPolicy(Policy policy) Deprecated. Sets the system-wide Policy object. |
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Constructors
Policy
protected Policy()
Deprecated.
Sole constructor. (For invocation by subclass constructors, typically implicit.)
Methods
getPolicy
public static Policy getPolicy()
Deprecated.
Returns the installed Policy object. This method first calls SecurityManager.checkPermission
with the AuthPermission("getPolicy")
permission to ensure the caller has permission to get the Policy object.
- Returns:
- the installed Policy. The return value cannot be
null
. - Throws:
-
SecurityException
- if the current thread does not have permission to get the Policy object. - See Also:
setPolicy(javax.security.auth.Policy)
setPolicy
public static void setPolicy(Policy policy)
Deprecated.
Sets the system-wide Policy object. This method first calls SecurityManager.checkPermission
with the AuthPermission("setPolicy")
permission to ensure the caller has permission to set the Policy.
- Parameters:
-
policy
- the new system Policy object. - Throws:
-
SecurityException
- if the current thread does not have permission to set the Policy. - See Also:
getPolicy()
getPermissions
public abstract PermissionCollection getPermissions(Subject subject, CodeSource cs)
Deprecated.
Retrieve the Permissions granted to the Principals associated with the specified CodeSource
.
- Parameters:
-
subject
- theSubject
whose associated Principals, in conjunction with the providedCodeSource
, determines the Permissions returned by this method. This parameter may benull
. -
cs
- the code specified by itsCodeSource
that determines, in conjunction with the providedSubject
, the Permissions returned by this method. This parameter may benull
. - Returns:
- the Collection of Permissions granted to all the
Subject
and code specified in the provided subject and cs parameters.
refresh
public abstract void refresh()
Deprecated.
Refresh and reload the Policy.
This method causes this object to refresh/reload its current Policy. This is implementation-dependent. For example, if the Policy object is stored in a file, calling refresh
will cause the file to be re-read.
- Throws:
-
SecurityException
- if the caller does not have permission to refresh the Policy.
© 1993, 2020, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/javase/8/docs/api/javax/security/auth/Policy.html