Create-Auth-Realm

Synopsis

 
asadmin [asadmin-options] create-auth-realm [--help]
--classname realm_class [--property(name=value)[:name=value]*]
[--target target_name] auth_realm_name

Description

The create-auth-realm subcommand adds the named authentication realm.

This subcommand is supported in remote mode only.

Options

asadmin-options: Options for the asadmin utility. For information about these options, see the asadmin help page. --help: -?: Displays the help text for the subcommand. --target: Specifies the target on which you are creating the realm. Valid values are
server;; Creates the realm on the default server instance. This is the default value. configuration_name;; Creates the realm in the specified configuration. cluster_name;; Creates the realm on all server instances in the specified cluster. instance_name;; Creates the realm on a specified server instance. --classname: 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, com.sun.enterprise.security.auth.realm.ldap.PamRealm, and com.sun.enterprise.security.auth.realm.solaris.SolarisRealm, or a custom realm. --property: 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, PamRealm, and SolarisRealm.
jaas-context;; Specifies the Java Authentication and Authorization Service (JAAS) context. assign-groups;; (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:
file;; Specifies the file that stores usernames, passwords, and group names. The default is domain-dir`/config/keyfile`. * You can specify the following properties for CertificateRealm:
LoginModule;; Specifies the name of a JAAS LoginModule to use for performing authentication. To use a JAAS LoginModule, you must first create an implementation of the javax.security.auth.spi.LoginModule interface, and then plug the module into a jaas-context. * You can specify the following properties for JDBCRealm:
datasource-jndi;; Specifies the jndi-name of the jdbc-resource for the database. user-table;; Specifies the name of the user table in the database. user-name-column;; Specifies the name of the user name column in the database’s user table. password-column;; Specifies the name of the password column in the database’s user table. group-table;; Specifies the name of the group table in the database. group-table;; Specify the group table for an authentication realm of class JDBCRealm. group-name-column;; Specifies the name of the group name column in the database’s group table. db-user;; (Optional) Allows you to specify the database username 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. db-password;; (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. group-table;; Specifies the name of the group table in the database. digest-algorithm;; (Optional) Specifies the digest algorithm. The default is SHA-256. You can use any algorithm supported in the JDK, or none.

 
asadmin> set server.security-service.property.default-digest-algorithm=MD5

 
asadmin> get server.security-service.property.default-digest-algorithm

Operands

auth_realm_name: A short name for the realm. This name is used to refer to the realm from, for example, web.xml.

Examples

Example 1 Creating a New Authentication Realm

This example creates a new file realm.

 
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.

Exit Status

0: subcommand executed successfully 1: error in executing the subcommand

See Also