Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
create-auth-realm --classname realm_class [--help] [ --property (name=value)[:name=value]*] [ --target target_name] auth_realm_name
The create-auth-realm subcommand adds the named authentication realm. This subcommand is supported in remote mode only.
Displays the help text for the subcommand.
This option is valid for Enterprise Server release prior to v3. This option has been retained for backward compatibility. In v3 and later, this option is ignored.
Java class which implements this realm. These include com.sun.enterprise.security.auth.realm.file.FileRealm, com.sun.enterprise.security.auth.realm.certificate.CertificateRealm, com.sun.enterprise.security.auth.realm.jdbc.JDBCRealm, com.sun.enterprise.security.auth.realm.ldap.LDAPRealm, and com.sun.enterprise.security.auth.realm.solaris.SolarisRealm, or a custom realm.
Optional attribute name/value pairs for configuring the authentication realm. Authentication realms require provider-specific properties, which vary based on implementation.
The following properties are common to all of the supported realms, which include FileRealm, CertificateRealm, JDBCRealm, LDAPRealm, and SolarisRealm.
Specifies the JAAS (Java Authentication and Authorization Service) context.
(optional) If this property is set, its value is taken to be a comma-separated list of group names. All clients who present valid certificates are assigned membership to these groups for the purposes of authorization decisions in the web and EJB containers.
Specific to each realm, you can specify the following properties.
You can specify the following properties for FileRealm:
Specifies the file that stores user names, passwords, and group names. The default is domain-dir/config/keyfile.
You can specify the following properties for CertificateRealm:
If true, specifies that client authentication is required for all applications that use the certificate realm. The default is false.
To require client authentication for a specific web application, set the method of authentication in the web.xml file to CLIENT-CERT.
You can specify the following properties for JDBCRealm:
Specifies the jndi-name of the jdbc-resource for the database.
Specifies the name of the user table in the database.
Specifies the name of the user name column in the database's user table.
Specifies the name of the password column in the database's user table.
Specifies the name of the group table in the database.
Specify the group table for an authentication realm of class JDBCRealm.
Specifies the name of the group name column in the database's group table.
(optional) Allows you to specify the database user name in the realm instead of the jdbc-connection-pool. This prevents other applications from looking up the database, getting a connection, and browsing the user table. By default, the jdbc-connection-pool configuration is used.
(optional) Allows you to specify the database password in the realm instead of the jdbc-connection-pool. This prevents other applications from looking up the database, getting a connection, and browsing the user table. By default, the jdbc-connection-pool configuration is used.
Specifies the name of the group table in the database.
(optional) Specifies the digest algorithm. The default is MD5. You can use any algorithm supported in the JDK, or none.
(optional) Specifies the encoding. Allowed values are Hex and Base64. If digest-algorithm is specified, the default is Hex. If digest-algorithm is not specified, by default no encoding is specified.
(optional) Specifies the charset for the digest algorithm.
You can specify the following properties for LDAPRealm:
Specifies the LDAP URL to your server.
Specifies the LDAP base DN for the location of user data. This base DN can be at any level above the user data, since a tree scope search is performed. The smaller the search tree, the better the performance.
(optional) Specifies the search filter to use to find the user. The default is uid=%s (%s expands to the subject name).
(optional) Specifies the base DN for the location of groups data. By default, it is same as the base-dn, but it can be tuned, if necessary.
(optional) Specifies the search filter to find group memberships for the user. The default is uniquemember=%d (%d expands to the user elementDN).
(optional) Specifies the LDAP attribute name that contains group name entries. The default is CN.
(optional) Specifies an optional DN used to authenticate to the directory for performing the search-filter lookup. Only required for directories that do not allow anonymous search.
(optional) Specifies the LDAP password for the DN given in search-bind-dn.
A short name for the realm. This name is used to refer to the realm from, for example, web.xml.
asadmin> create-auth-realm --classname com.sun.enterprise.security.auth.realm.file.FileRealm --property file=${com.sun.aas.instanceRoot}/config/ admin-keyfile:jaas-context=fileRealm file Command create-auth-realm executed successfully |
Where file is the authentication realm created.
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also