Sun Java logo     Previous      Contents      Index      Next     

Sun logo
Sun Java System Application Server Enterprise Edition 8 2004Q4 Beta Administration Guide 

Chapter 14
Configuring Security

This chapter describes some core application server security concepts, and describes how to configure security for the Sun Java System Application Server 2004Q4 Beta. This chapter contains the following topics:


About Application Server Security

Overview of Security

Security is about protecting data: how to prevent unauthorized access or damage to it in storage or transit. The Application Server has a dynamic, extensible security architecture based on the J2EE standard. Built in security features include cryptography, authentication and authorization, and public key infrastructure. The Application Server is built on the Java security model, which uses a sandbox where applications can run safely, without potential risk to systems or users. The following topics are discussed:

Understanding Application and System Security

Broadly, there are two kinds of application security:

In addition to application security, there is also system security, which affects all the applications on an Application Server system.

Programmatic security is controlled by the application developer, so this document does not discuss it; declarative security is somewhat less so, and this document touches on it occasionally. This document is intended primarily for system administrators, and so focuses on system security.

Tools for Managing Security

The Application Server provides the following tools for managing security:

The Java 2 Platform, Standard Edition (J2SE) provides two tools for managing security:

For more information on using keytool, policytool, and other Java security tools, see Java 2 SDK Tools and Utilities at http://java.sun.com/j2se/1.4.2/docs/tooldocs/tools.html#security.

In the Enterprise Edition, two other tools that implement Network Security Services (NSS) are available for managing security. For more information on NSS, go to http://www.mozilla.org/projects/security/pki/nss/. The tools for managing security include the following:

For more information on using certutil, pk12util, and other NSS security tools, see NSS Security Tools at http://www.mozilla.org/projects/security/pki/nss/.

Managing Security of Passwords

In this release of the Application Server, the file domain.xml, which contains the specifications for a particular domain, initially contains the password of the IMQ broker in clear text. The element in the domain.xml file that contains this password is the admin-password attribute of the jms-host element. Because this password is not changeable at installation time, it is not a significant security impact.

However, use the Admin Console to add users and resources and assign passwords to these users and resources. Some of these passwords are written to the domain.xml file in clear text, for example, passwords for accessing a database. Having these passwords in clear text in the domain.xml file can present a security hazard. You can encrypt any password in domain.xml, including the admin-password attribute or a database password by following this procedure:

  1. From the directory where the domain.xml file resides (which is install_dir/domains/domain_dir/config by default), run the following asadmin command:
  2. asadmin create-password-alias <alias-name>

    For example,

    asadmin create-password-alias jms-password

    A password prompt appears (admin in this case). Refer to the manpages for the create-password-alias, list-password-aliases, delete-password-alias commands for more information.

  3. Remove and replace the password in domain.xml. This is accomplished using the asadmin set command. An example of using the set command for this purpose is as follows:
  4. asadmin set server.jms-service.jms-host.default_JMS_host.admin-password=${ALIAS=jms -password}
  5. Restart the Application Server for the relevant domain.
Protecting files with encoded passwords

Some files contain encoded passwords that need protecting using file system permissions. These files include the following:

Changing the Master Password

The master password (MP) is an overall shared password. It is never used for authentication and is never transmitted over the network. This password is the choke point for overall security; the user can choose to enter it manually when required, or obscure it in a file. It is the most sensitive piece of data in the system. The user can force prompting for the MP by removing this file. When the master password is changed, it is re-saved in the master-password keystore.

To change the master password, the following procedure must be followed:

  1. Stop the Application Server for the domain. Use the asadmin command change-master-password that prompts for the old and new passwords, then re-encrypts all dependent items. For example,
  2. asadmin change-master-password>
    Please enter the master password>
    Please enter the new master password>
    Please enter the the new master password again>
  3. Restart the Application Server.

WARNING: At this point in time, server instances that are running must not be started and running server instances must not be restarted until the SMP on their corresponding Node Agent has been changed. If a server instance is restarted before changing its SMP, it will fail to come up.

  1. Stop each Node Agent and its related servers one at a time. Run the asadmin change-master-password command again, and then restart the Node Agent and its related servers.
  2. Continue with the next Node Agent until all Node Agents have been addressed. In this way, a rolling change may be accomplished.
Changing the Admin Password

Encrypting the admin password was discussed in "Managing Security of Passwords". Encrypting the admin password is strongly encouraged. If you want to change the admin password before encrypting it, use the asadmin set command. An example of using the set command for this purpose is as follows:

asadmin set server.jms-service.jms-host.default_JMS_host.admin-password=new_pwd

It is also possible to change the admin password using Admin Console. To change the admin password using the Admin Console, follow these steps.

  1. In the Admin Console tree component, expand the Configurations node.
  2. Select the instance you want to configure:
    1. To configure a particular instance, select the instance's config node. For example, the default instance, server, select the server-config node.
    2. To configure the default settings for all instances, select the default-config node.
  3. Expand the Security node.
  4. Expand the Realms node.
  5. Select the admin-realm node.
  6. Click the Manage Users button from the Edit Realm page.
  7. Select the user named admin.
  8. Enter the new password and confirm the password.
  9. Click Save to save or click Close to close without saving.

Assigning Security Responsibilities

Security responsibilities are assigned to the following:

Application Developer

The application developer is responsible for the following:

An application developer can use tools such as deploytool to edit application deployment descriptors. These security tasks are discussed in more detail in the Security chapter of The J2EE 1.4 Tutorial, which can be viewed at the following URL:

Application Deployer

The application deployer is responsible for:

An application deployer can use tools such as deploytool to edit application deployment descriptors. These security tasks are discussed in more detail in the Security chapter of The J2EE 1.4 Tutorial, which can be viewed at the following URL:

System Administrator

The system administrator is responsible for:

A system administrator uses the Admin Console to manage server security settings and keytool to manage certificates. This document is intended primarily for system administrators.

About Authentication and Authorization

Authentication and authorization are central concepts of application server security. The following topics are discussed related to authentication and authorization:

Authenticating Entities

Authentication is the way an entity (a user, an application, or a component) determines that another entity is who it claims to be. An entity uses security credentials to authenticate itself. The credentials may be a user name and password, a digital certificate, or something else.

Typically, authentication means a user logging in to an application with a user name and password; but it might also refer to an EJB providing security credentials when it requests a resource from the server. Usually, servers or applications require clients to authenticate; additionally, clients can require servers to authenticate themselves, too. When authentication is bidirectional, it is called mutual authentication.

When an entity tries to access a protected resource, the Application Server uses the authentication mechanism configured for that resource to determine whether to grant access. For example, a user can enter a user name and password in a Web browser, and if the application verifies those credentials, the user is authenticated. The user is associated with this authenticated security identity for the remainder of the session.

The Application Server supports four types of authentication, as outlined in Table 1-1. An application specifies the type of authentication it uses within its deployment descriptors. For more information on using deploytool to configure the authentication method for an application, see The J2EE 1.4 Tutorial at the following URL:

http://java.sun.com/j2ee/1.4/docs/tutorial/doc/index.html

Table 14-1 Application Server Authentication Methods

Authentication Method

Communication Protocol

Description

User Credential Encryption

Basic

HTTP (SSL optional)

Uses the server's built-in pop-up login dialog box.

None, unless using SSL.

Form-based

HTTP (SSL optional)

Application provides its own custom login and error pages.

None, unless using SSL.

Client Certificate

HTTPS
(HTTP over SSL)

Server authenticates the client using a public key certificate.

SSL

Verifying Single Sign-On

Single sign-on enables multiple applications in one virtual server instance to share user authentication state. With single sign-on, a user who logs in to one application becomes implicitly logged in to other applications that require the same authentication information.

Single sign-on is based on groups. All Web applications whose deployment descriptor defines the same group and use the same authentication method (basic, form, digest, certificate) share single sign-on.

Single sign-on is enabled by default for virtual servers defined for the Application Server. For information on disabling single sign-on, see "Configuring Single Sign-On (SSO)".

Authorizing Users

Once a user is authenticated, the level of authorization determines what operations can be performed. A user's authorization is based on his role. For example, a human resources application may authorize managers to view personal employee information for all employees, but allow employees to view only their own personal information. For more on roles, see "Understanding Users, Groups, Roles, and Realms".

Specifying JACC Providers

JACC (Java Authorization Contract for Containers) is part of the J2EE 1.4 specification that defines an interface for pluggable authorization providers. This enables the administrator to set up third-party plug-in modules to perform authorization.

By default, the Application Server provides a simple, file-based authorization engine that complies with the JACC specification. It is also possible to specify additional third-party JACC providers.

JACC providers use the Java Authentication and Authorization Service (JAAS) APIs. JAAS enables services to authenticate and enforce access controls upon users. It implements a Java technology version of the standard Pluggable Authentication Module (PAM) framework.

Auditing Authentication and Authorization Decisions

The Application Server can provide an audit trail of all authentication and authorization decisions through audit modules. The Application Server provides a default audit module, as well as the ability to customize the audit modules. For information on developing custom audit modules, see the Application Server Developer's Guide.

Configuring Message Security

Message Security enables a server to perform end-to-end authentication of web service invocations and responses at the message layer. The Application Server provides default SOAP message security providers and also enables you to add and configure your own message security providers. A message security configuration for a given message layer can contain several messages. It is also possible to configure custom security providers. The message security providers provide information such as the type of authentication that is required for the request and response messages. The types of authentication that are supported include the following:

Several default message security providers are included with this release. The default message security configuration is configured for authentication for the SOAP layer. This default configuration includes a default ClientProvider and a default ServerProvider. Configure a custom provider to add to the SOAP layer (at this time it is the only layer at which the Application Server containers will invoke providers) or use the default providers.

Understanding Users, Groups, Roles, and Realms

The Application Server enforces its authentication and authorization policies upon the following entities:

Note: Users and groups are designated for the entire Application Server, whereas each application defines its own roles. When the application is being packaged and deployed, the application specifies mappings between users/groups and roles, as illustrated in Figure 1-1.

Figure 14-1 Role Mapping

Users

A user is an individual (or application program) identity that has been defined in the Application Server. A user can be associated with a group. The Application Server authentication service can govern users in multiple realms.

Groups

A J2EE group (or simply group) is a category of users classified by common traits, such as job title or customer profile. For example, users of an e-commerce application might belong to the customer group, but the big spenders would belong to the preferred group. Categorizing users into groups makes it easier to control the access of large numbers of users.

Roles

A role defines which applications and what parts of each application users can access and what they can do. In other words, roles determine users' authorization levels.

For example, in a personnel application all employees might have access to phone numbers and email addresses, but only managers would have access to salary information. The application might define at least two roles: employee and manager; only users in the manager role are allowed to view salary information.

A role is different from a user group in that a role defines a function in an application, while a group is a set of users who are related in some way. For example, in the personnel application there might be groups such as full-time, part-time, and on-leave, but users in all these groups would still be in the employee role.

Roles are defined in application deployment descriptors. In contrast, groups are defined for an entire server and realm. The application developer or deployer maps roles to one or more groups for each application in its deployment descriptor.

Realms

A realm, also called a security policy domain or security domain, is a scope over which the server defines and enforces a common security policy. In practical terms, a realm is a repository where the server stores user and group information.

The Application Server comes pre-configured with three realms: file (the initial default realm), certificate, and admin-realm. It is possible to also set up ldap, solaris, or custom realms. Applications can specify the realm to use in their deployment descriptor. If they do not specify a realm, the Application Server uses its default realm.

In the file realm, the server stores user credentials locally in a file named keyfile. You can use the Admin Console to manage users in the file realm. For more information, see "Managing file Realm Users".

In the certificate realm, the server stores user credentials in a certificate database. When using the certificate realm, the server uses certificates with the HTTPS protocol to authenticate Web clients. For more information about certificates, see "Introduction to Certificates and SSL".

The admin-realm is also a FileRealm and stores administrator user credentials locally in a file named admin-keyfile. Use the Admin Console to manage users in this realm in the same way you manage users in the file realm. For more information, see "Managing file Realm Users".

In the ldap realm the server gets user credentials from a Lightweight Directory Access Protocol (LDAP) server such as the Sun Java System Directory Server. LDAP is a protocol for enabling anyone to locate organizations, individuals, and other resources such as files and devices in a network, whether on the public Internet or on a corporate intranet. Consult your LDAP server documentation for information on managing users and groups in the ldap realm.

In the solaris realm the server gets user credentials from the Solaris operating system. This realm is supported on the Solaris 9 OS and later. Consult your Solaris documentation for information on managing users and groups in the solaris realm.

A custom realm is any other repository of user credentials, such as a relational database or third-party component. For more information, see "Creating a Custom Realm".

Introduction to Certificates and SSL

The following topics are discussed in this section:

About Digital Certificates

Digital certificates (or simply certificates) are electronic files that uniquely identify people and resources on the Internet. Certificates also enable secure, confidential communication between two entities.

There are different kinds of certificates, such as personal certificates, used by individuals, and server certificates, used to establish secure sessions between the server and clients through secure sockets layer (SSL) technology. For more information on SSL, see "About Secure Sockets Layer".

Certificates are based on public key cryptography, which uses pairs of digital keys (very long numbers) to encrypt, or encode, information so it can be read only by its intended recipient. The recipient then decrypts (decodes) the information to read it.

A key pair contains a public key and a private key. The owner distributes the public key and makes it available to anyone. But the owner never distributes the private key; it is always kept secret. Because the keys are mathematically related, data encrypted with one key can be decrypted only with the other key in the pair.

A certificate is like a passport: it identifies the holder and provides other important information. Certificates are issued by a trusted third party called a Certification Authority (CA). The CA is analogous to passport office: it validates the certificate holder's identity and signs the certificate so that it cannot be forged or tampered with. Once a CA has signed a certificate, the holder can present it as proof of identity and to establish encrypted, confidential communications.

Most importantly, a certificate binds the owner's public key to the owner's identity. Like a passport binds a photograph to personal information about its holder, a certificate binds a public key to information about its owner.

In addition to the public key, a certificate typically includes information such as:

Digital Certificates are governed by the technical specifications of the x.509 format. To verify the identity of a user in the certificate realm, the authentication service verifies an X.509 certificate, using the common name field of the X.509 certificate as the principal name.

About Certificate Chains

Web browsers are pre-configured with a set of root CA certificates that the browser automatically trusts. Any certificates from elsewhere must come with a certificate chain to verify their validity. A certificate chain is series of certificates issued by successive CAs, eventually ending in a root CA certificate.

When a certificate is first generated, it is a self-signed certificate. A self-signed certificate is one for which the issuer (signer) is the same as the subject (the entity whose public key is being authenticated by the certificate). When the owner sends a certificate signing request (CSR) to a CA, then imports the response, the self-signed certificate is replaced by a chain of certificates. At the bottom of the chain is the certificate (reply) issued by the CA authenticating the subject's public key. The next certificate in the chain is one that authenticates the CA's public key. Usually, this is a self-signed certificate (that is, a certificate from the CA authenticating its own public key) and the last certificate in the chain.

In other cases, the CA can return a chain of certificates. In this case, the bottom certificate in the chain is the same (a certificate signed by the CA, authenticating the public key of the key entry), but the second certificate in the chain is a certificate signed by a different CA, authenticating the public key of the CA to which you sent the CSR. Then, the next certificate in the chain is a certificate authenticating the second CA's key, and so on, until a self-signed root certificate is reached. Each certificate in the chain (after the first) thus authenticates the public key of the signer of the previous certificate in the chain.

About Secure Sockets Layer

Secure Sockets Layer (SSL) is the most popular standard for securing Internet communications and transactions. Web applications use HTTPS (HTTP over SSL), which uses digital certificates to ensure secure, confidential communications between server and clients. In an SSL connection, both the client and the server encrypt data before sending it, then decrypt it upon receipt.

When a Web browser (client) wants to connect to a secure site, an SSL handshake happens:

After the handshake, the client has verified the identity of the Web site, and only the client and the Web server have a copy of the session key. From this point forward, the client and the server use the session key to encrypt all their communications with each other. Thus, their communications are ensured to be secure.

The newest version of the SSL standard is called TLS (Transport Layer Security). The Application Server supports the Secure Sockets Layer (SSL) 3.0 and the Transport Layer Security (TLS) 1.0 encryption protocols.

To use SSL, the Application Server must have a certificate for each external interface, or IP address, that accepts secure connections. The HTTPS service of most Web servers will not run unless a digital certificate has been installed. Use the procedure described in "Generating a Server Certificate" to set up a digital certificate that your Web server can use for SSL.

About Ciphers

A cipher is a cryptographic algorithm used for encryption or decryption. SSL and TLS protocols support a variety of ciphers used to authenticate the server and client to each other, transmit certificates, and establish session keys.

Some ciphers are stronger and more secure than others. Clients and servers can support different cipher suites. Choose ciphers from the SSL3 and TLS protocols. During a secure connection, the client and the server agree to use the strongest cipher they both have enabled for communication, so it is usually sufficient to enable all ciphers.

Using Name-based Virtual Hosts

Using name-based virtual hosts for a secure application can be problematic. This is a design limitation of the SSL protocol itself. The SSL handshake, where the client browser accepts the server certificate, must occur before the HTTP request is accessed. As a result, the request information containing the virtual host name cannot be determined prior to authentication, and it is therefore not possible to assign multiple certificates to a single IP address.

If all virtual hosts on a single IP address need to authenticate against the same certificate, the addition of multiple virtual hosts probably will not interfere with normal SSL operations on the server. Be aware, however, that most browsers will compare the server's domain name against the domain name listed in the certificate, if any (applicable primarily to official, CA-signed certificates). If the domain names do not match, these browsers display a warning. In general, only address-based virtual hosts are commonly used with SSL in a production environment.

About Firewalls

A firewall controls the flow of data between two or more networks, and manages the links between the networks. A firewall can consist of both hardware and software elements. This section describes some common firewall architectures and their configuration. The information here pertains primarily to the Application Server. For details about a specific firewall technology, refer to the documentation from your firewall vendor.

In general, configure the firewalls so that clients can access the necessary TCP/IP ports. For example, if the HTTP listener is operating on port 8080, configure the firewall to allow HTTP requests on port 8080 only. Likewise, if HTTPS requests are setup for port 8181, you must configure the firewalls to allow HTTPS requests on port 8181.

If direct Remote Method Invocations over Internet Inter-ORB Protocol (RMI-IIOP) access from the Internet to EJB modules are required, open the RMI-IIOP listener port as well, but this is strongly discouraged because it creates security risks.

In double firewall architecture, you must configure the outer firewall to allow for HTTP and HTTPS transactions. You must configure the inner firewall to allow the HTTP server plug-in to communicate with the Application Server behind the firewall.

Managing Security With the Admin Console

The Admin Console provides the means to manage the following aspects of security:

Server Security Settings

On the Security Settings page, set properties for the entire server, including specifying the default realm, the anonymous role, and the default principal user name and password. For more information, see "Configuring Security Settings".

See Also:

Realms and file Realm Users

The concept of realms was introduced in "Understanding Users, Groups, Roles, and Realms". With the Admin Console, perform the following tasks:

See "Admin Console Tasks for Realms" for details on these tasks.

See Also:

JACC Providers

JACC providers were introduced in "Specifying JACC Providers". With the Admin Console, perform the following tasks:

See "Admin Console Tasks for JACC Providers" for details on these tasks.

See Also:

Audit Modules

Audit modules were introduced in "Auditing Authentication and Authorization Decisions". Auditing is the method by which significant events, such as errors or security breaches, are recorded for subsequent examination. All authentication events are logged to the Application Server logs. A complete access log provides a sequential trail of Application Server access events.

With the Admin Console, perform the following tasks:

See "Admin Console Tasks for Audit Modules" for details on these tasks.

See Also:

Message Security

The concept of message security was introduced in "Configuring Message Security". With the Admin Console, perform the following tasks:

See "Admin Console Tasks for Message Security" for details on these tasks.

See Also:

HTTP and IIOP Listener Security

Each virtual server in the HTTP service provides network connections through one or more HTTP listeners. For general information about the HTTP service and HTTP listeners, see "What Is the HTTP Service?"

The Application Server supports CORBA (Common Object Request Broker Architecture) objects, which use the Internet Inter-Orb Protocol (IIOP) to communicate across the network. An IIOP listener accepts incoming connections from remote clients of EJBs and from other CORBA-based clients. For general information on IIOP listeners, see "IIOP Listeners".

With the Admin Console, perform the following tasks:

See "Admin Console Tasks for Listeners" for details on these tasks.

See Also:

Admin Service Security

The Admin Service determines whether the server instance is a regular instance, a domain administration server (DAS), or a combination. In the Platform Edition, there is only one server instance, and it is a combination. Use the Admin Service to configure a JSR-160 compliant remote JMX connector, which handles communication between the domain administration server and the node agents, which manage server instances on a host machine, for remote server instances.

With the Admin Console, perform the following tasks:

See "Configuring Security for the Admin Service's JMX Connector" for details on these tasks.

See Also:

Security Maps

The concept of security maps for connector connection pools is introduced in "About Security Maps". With the Admin Console, perform the following tasks:

See "Admin Console Tasks for Connector Connection Pools" for details on these tasks.

See Also:


Admin Console Tasks for Security

Configuring Security Settings

The Security page in the Admin Console enables you to set a variety of system-wide security settings.

To edit these settings, follow these steps.

  1. In the Admin Console tree component, expand the Configurations node.
  2. Select the instance to configure:
    1. To configure a particular instance, select the instance's config node. For example, the default instance, server, select the server-config node.
    2. To configure the default settings for all instances, select the default-config node.
  3. Select the Security node.
  4. The Security page displays.

  5. Modify the values as necessary. Table 1-2 describes the settings on this page.

    Table 14-2 General Security Settings

    Setting

    Description

    Audit Logging

    Select to enable audit logging. If enabled, the server will load and run all the audit modules specified in the Audit Modules setting. If disabled, the server does not access audit modules. Disabled by default.

    Default Realm

    The active (default) realm the server uses for authentication. Applications use this realm unless they specify a different realm in their deployment descriptor. All configured realms appear in the list. The initial default realm is the file realm.

    Anonymous Role

    The name for the default or anonymous role. The anonymous role is assigned to all users. Applications can use this role in their deployment descriptors to grant authorization to anyone.

    Default Principal

    Specifies the default user name. The server uses this when no principal is provided. If you enter a value in this field, enter a corresponding value in the Default Principal Password field.

    This attribute is not required for normal server operation.

    Default Principal Password

    Password of the default principal specified in the Default Principal field.

    This attribute is not required for normal server operation.

    JACC

    Class name of a configured JACC provider. See "Creating a JACC Provider" for Information on adding JACC providers.

    Audit Modules

    List of audit module provider classes, delimited by commas. A module listed here must already be configured. If Audit Logging is enabled, this setting must list audit modules. By default, the server uses an audit module named default. For information on creating new audit modules, see "Creating an Audit Module".

  6. Enter additional properties to pass to the Java Virtual Machine (JVM) in the Additional Properties section.
  7. Valid properties are dependent upon the type of realm being configured. Valid properties are discussed in the following sections:

  8. Select Save to save the changes or Load Defaults to restore the default values

Controlling Access to Administration Tools

Only users in the asadmin group are able to access Admin Console and the asadmin command line utility.

To give a user access to these administration tools, add them to the asadmin group in the admin-realm. To do this, follow these steps.

  1. In the Admin Console tree component, expand the Configurations node.
  2. Select the instance to configure:
    1. To configure a particular instance, select the instance's config node. For example, the default instance, server, select the server-config node.
    2. To configure the default settings for all instances, select the default-config node.
  3. Expand the Security node.
  4. Expand the Realms node.
  5. Select the admin-realm node.
  6. Click the Manage Users button from the Edit Realm page.
  7. Initially after installation, the administrator user name and password entered during installation are listed in a file named admin-keyfile. By default, this user belongs to the group asadmin, which gives rights to modify the Application Server. Assign users to this group only if you want to grant them administrator privileges for the Application Server.

    If you add users to the admin-realm realm, but assign the user to a group other than asadmin, the user information will still be written to the file named admin-keyfile, but the user will have no access to administrative tools or to applications in the file realm.

  8. Click New to add a new user to the admin-realm realm.
  9. Enter the correct information into the User ID, Password, and Group List fields. To authorize a user to make modifications to the Application Server, include the asadmin group in the Group List.
  10. Click OK to add this user to the admin-realm realm or click Cancel to quit without saving.

See Also:

Configuring Mutual Authentication

In mutual authentication, both server and client-side authentication are enabled. To test mutual authentication, a client with a valid certificate must exist. For information on creating a client certificate, see The J2EE 1.4 Tutorial at:

http://java.sun.com/j2ee/1.4/docs/tutorial/doc/index.html

Enabling Mutual Authentication for the certificate Realm

The Application Server uses the certificate realm for HTTPS authentication.

To specify mutual authentication for all the applications that use this realm, follow these steps.

  1. In the Admin Console tree component, expand the Configurations node.
  2. Select the instance to configure:
    1. To configure a particular instance, select the instance's config node. For example, the default instance, server, select the server-config node.
    2. To configure the default settings for all instances, select the default-config node.
  3. Expand the Security node.
  4. Expand the Realms node.
  5. Select the certificate realm.
  6. Click the Add Property button.
    • In the Name field, enter clientAuth.
    • In the Value field, enter true.
  7. Click Save.
  8. Restart the Application Server if Restart Required displays in the console.
  9. After restarting the server, mutual authentication requires client authentication for all applications that use the certificate realm.

Enabling Mutual SSL Authentication in an Application

To enable mutual authentication for a specific application, use deploytool to set the method of authentication to Client-Certificate. For more information about using deploytool, refer to the Security chapter of The J2EE 1.4 Tutorial at:

http://java.sun.com/j2ee/1.4/docs/tutorial/doc/index.html.

Configuring Single Sign-On (SSO)

Single sign-on enables multiple applications to share user sign-on information, rather than requiring each application to have separate user sign-on. Applications using single sign-on authenticate the user one time, and the authentication information is propagated to all other involved applications.

Single sign-on applies to Web applications configured for the same realm and virtual server.

Note: Single sign-on uses an HTTP cookie to transmit a token that associates each request with the saved user identity, so it can be used only when the browser client supports cookies.

Single sign-on operates according to the following rules:

Single sign-on is enabled by default for the Application Server. To disable it or configure other properties, follow these steps.

  1. In the Admin Console tree component, expand the Configurations node.
  2. Select the instance to configure:
    1. To configure a particular instance, select the instance's config node. For example, the default instance, server, select the server-config node.
    2. To configure the default settings for all instances, select the default-config node.
  3. Expand the HTTP Service node.
  4. Expand the Virtual Servers node, and select the virtual server to be configured for single sign-on support.
  5. Click Add Property.
  6. A blank property entry is added to the bottom of the list.

  7. Enter sso-enable in the Name field.
  8. Enter false in the Value field to disable, enter true to enable SSO. SSO is enabled by default.
  9. Add or change any other single sign-on properties by clicking Add Property and configuring any applicable SSO properties, as discussed in Table 1-3:

    Table 14-3 Virtual Servers SSO Properties

    Property Name

    Description

    Values

    sso-max-inactive-seconds

    Number of seconds after which a user's single sign-on record becomes eligible for purging, if no client activity is received. Access to any of the applications on the virtual server keeps the single sign-on record active.

    Default is 300 seconds (5 minutes). A higher value provides longer persistence for users, but consumes more memory on the server.

    sso-reap-interval-seconds

    Interval (in seconds) between purges of expired single sign-on records.

    Default is 60.

  10. Click Save.
  11. Restart the Application Server if Restart Required displays in the console.


Admin Console Tasks for Realms

Creating a Realm

The Application Server comes preconfigured with three realms: file, certificate, and admin-realm. It is also possible to create ldap, solaris, and custom realms. Generally, you will have one realm of each type on a server, but on the Application Server there are two file realms: file and admin-realm. There are two realms of the same type used for two different purposes. It is also possible to have a different certificate database for each virtual server on your system.

To create a security realm, follow these steps.

  1. In the Admin Console tree component, expand the Configurations node.
  2. Select the instance you want to configure:
    1. To configure a particular instance, select the instance's config node. For example, the default instance, server, select the server-config node.
    2. To configure the default settings for all instances, select the default-config node.
  3. Expand the Security node.
  4. Select the Realms node.
  5. On the Realms page, click New.
  6. The Create Realm page is displayed.

  7. Enter a name for the realm in the Name field: file, certificate, ldap, solaris, or the name of a custom realm.
  8. Specify the class name for the realm being created. Valid choices are shown in Table 1-4:

    Table 14-4 Valid values for realm class name

    Realm Name

    Class Name

    file

    com.sun.enterprise.security.auth.realm.file.FileRealm

    certificate

    com.sun.enterprise.security.auth.realm.certificate.CertificateRealm

    ldap

    com.sun.enterprise.security.auth.realm.ldap.LDAPRealm

    solaris

    com.sun.enterprise.security.auth.realm.solaris.SolarisRealm

    custom

    Name of login realm class

  9. Add the required properties and any desired optional properties for the realm.
  10. To add a property:

    1. Click Add Property.
    2. In the Name field, enter the name of the property.
    3. For a description of file realm properties, see "Editing the file and admin-realm Realms".
    4. For a description of certificate realm properties, see "Editing the certificate Realm".
    5. For a description of ldap realm properties, see "Creating the ldap Realm".
    6. For a description of solaris realm properties, see "Creating the solaris Realm".
    7. For a description of custom realm properties, see "Creating a Custom Realm".
    8. In the Value field, enter the value of the property.
  11. Click OK.

Equivalent asadmin command: create-auth-realm

Creating the ldap Realm

The ldap realm performs authentication using information from an LDAP server. User information includes user name, password, and the groups to which the user belongs. To use an LDAP realm, have the users and groups already defined in your LDAP directory.

To create an LDAP realm, follow the steps in "Creating a Realm" for adding a new realm, then add the properties shown in Table 1-5.

Table 14-5 Required properties for ldap realm

Property Name

Description

Value

directory

LDAP URL of the directory server.

LDAP URL of the form ldap://hostname:port
For example, ldap://myldap.foo.com:389.

base-dn

Base Distinguished Name (DN) for the location of user data, which 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.

Domain for the search, for example: dc=siliconvalley, dc=BayArea, dc=sun, dc=com.

jaas-context

Type of login module to use for this realm.

Must be ldapRealm.

Optional properties for the ldap realm are listed in Table 1-6:

Table 14-6 Optional properties for ldap realm

Property Name

Description

Default

search-filter

Search filter to use to find the user.

uid=%s (%s expands to the subject name).

group-base-dn

Base DN for the location of group data.

Same as the base-dn, but it can be tuned if necessary.

group-search-filter

Search filter to find group memberships for the user.

uniquemember=%d (%d expands to the user element DN).

group-target

LDAP attribute name that contains group name entries.

CN

search-bind-dn

Optional DN used to authenticate to the directory for performing the search-filter lookup. Only required for directories that do not allow anonymous search.

 

search-bind-password

LDAP password for the DN given in search-bind-dn.

 

Example

For example, suppose an LDAP user, Joe Java, is defined in the LDAP directory as follows:

uid=jjava,ou=People,dc=acme,dc=com
uid=jjava
givenName=joe
objectClass=top
objectClass=person
objectClass=organizationalPerson
objectClass=inetorgperson
sn=java
cn=Joe Java

Using the example code, you can enter the values shown in Table 1-7 when creating or editing the ldap realm:

Table 14-7 Example ldap realm values

Property Name

Property Value

directory

LDAP URL to your server, for example: ldap://ldap.acme.com:389

base-dn

ou=People,dc=acme,dc=com.

Can be rooted higher, for example dc=acme, dc=com, but searches would traverse a larger part of the tree, reducing performance.

jaas-context

ldapRealm

Creating the solaris Realm

The solaris realm gets user and group information from the underlying Solaris user database, as determined by the system's configuration. The solaris realm invokes the underlying PAM infrastructure for authenticating. If the configured PAM modules require root privileges, the domain must run as root to use this realm. For details, see the Solaris documentation for security services.

The solaris realm has one required property, jaas-context that specifies the type of login module to use. The property value must be solarisRealm.

Note: The solaris realm is supported only for Solaris 9 or later.

Creating a Custom Realm

In addition to the four built-in realms, you can also create custom realms that store user data in some other way, such as in a relational database. Development of a custom realm is outside the scope of this document. For more information, see the Application Server Developer's Guide. See http://developers.sun.com/prodtech/appserver/reference/techart/as8_authentication/index.html for an example implementation of a custom realm

As an administrator, the main thing you need to know is that a custom realm is implemented by a class (called the LoginModule) derived from the Java Authentication and Authorization Service (JAAS) package.

To configure the Application Server to use a custom realm:

  1. Follow the procedure outline in "Creating a Realm", entering the name of the custom realm and the name of the LoginModule class. Any unique name can be used for the custom realm, for example myCustomRealm.
  2. Add the properties shown in Table 1-8:

    Table 14-8 Valid properties for a custom realm

    Property Name

    Property Value

    jaas-context

    LoginModule class name, for example simpleCustomRealm

    auth-type

    Description of the realm, for example "A simple example custom realm".

  3. Click OK.
  4. Edit the domain's login configuration file, install_dir/domains/domain_name/config/login.conf, and add the fully-qualified class name of the JAAS LoginModule at the end of the file, as follows:
  5. realmName {
       fully-qualified-LoginModule-classname required;
    };

    For example,

    myCustomRealm {
       com.foo.bar.security.customrealm.simpleCustomLoginModule required;
    };
  6. Copy the LoginModule class and all dependent classes into the directory install_dir/domains/domain_name/lib/classes.
  7. Restart the Server if Restart Required displays in the console.
  8. Make sure that the realm is properly loaded.
  9. Check install_dir/domains/domain_name/logs/server.log to make sure the server loaded the realm. The server should invoke the realm's init() method.

See also:

Editing a Realm

To edit a realm, follow these steps.

  1. In the Admin Console tree component, expand the Configurations node.
  2. Select the instance to configure:
    1. To configure a particular instance, select the instance's config node. For example, the default instance, server, select the server-config node.
    2. To configure the default settings for all instances, select the default-config node.
  3. Expand the Security node.
  4. Expand the Realms node.
  5. Select the name of an existing realm.
  6. The Edit Realm page displays.

  7. Edit existing properties and their values as desired.
  8. For information on file realm properties, see "Editing the file and admin-realm Realms". To manage users in the file realm, click the Manager Users button; see "Managing file Realm Users" for more information.

    For information on certificate realm properties, see "Editing the certificate Realm".

  9. To add additional properties, click the Add Properties button. The page displays a new row. Enter a valid property name and property value. See the following tables for a description of the optional properties that can be configured:
    • Table 1-9 describes properties for the file realm.
    • Table 1-10 describes optional properties for the certificate realm.
    • Table 1-5 and Table 1-6 describe properties for the ldap realm.
    • Table 1-8 describes valid properties for a custom realm.
  10. Click Save to save the changes.

Editing the file and admin-realm Realms

The server maintains all user, group, and password information in a file named keyfile for the file realm and admin-keyfile for the admin-realm. For both, the file property specifies the location of the keyfile.

Table 14-9 Required properties for file realms

Property name

Description

Default Value

file

Full path and name of the keyfile.

install_dir/domains/domain-name/
config/keyfile

jaas-context

Type of login module to use for this realm.

fileRealm is the only valid value

The keyfile is initially empty, so users must be added before the file realm is used. For instructions, see "Managing file Realm Users".

The admin-keyfile initially contains the admin user name, the admin password in an encrypted format, and the group to which this user belongs, which is asadmin by default. For more information on adding users to the admin-realm, read "Controlling Access to Administration Tools".

Note: Users in the group asadmin in the admin-realm are authorized to use the Admin Console and asadmin tools. Add only users to this group that have server administrative privileges.

Managing Users with Network Security Services (NSS)

In the Enterprise Edition, you can manage users using the Admin Console as discussed in "Managing file Realm Users" or you can manage users using NSS tools. Network Security Services (NSS) is a set of libraries designed to support cross-platform development of security-enabled client and server applications. Applications built with NSS can support SSL v2 and v3, TLS, PKCS #5, PKCS #7, PKCS #11, PKCS #12, S/MIME, X.509 v3 certificates, and other security standards. For detailed information, link to the following URLs:

Managing file Realm Users

Manage file realm users with the Admin Console. Users and groups in the file realm are listed in the keyfile, whose location is specified by the file property.

Note: It is also possible to use these steps to add users to any file realm, including the admin-realm. Simply substitute the name of the target realm in place of the file realm referenced in this section.

A user in the file realm can belong to a J2EE group, a category of users classified by common traits. For example, customers of an e-commerce application might belong to the CUSTOMER group, but the big spenders would belong to the PREFERRED group. Categorizing users into groups makes it easier to control the access of large numbers of users.

Initially after installation of the Application Server, the only user is the administrator entered during installation. By default, this user belongs to the group asadmin, in the realm admin-realm, which gives rights to modify the Application Server. Any users assigned to this group will have administrator privileges, that is, they will have access to asadmin and Admin Console.

To manage file realm users, follow these steps.

  1. In the Admin Console tree component, expand the Configurations node.
  2. Select the instance to configure:
    1. To configure a particular instance, select the instance's config node. For example, the default instance, server, select the server-config node.
    2. To configure the default settings for all instances, select the default-config node.
  3. Expand the Security node.
  4. Expand the Realms node.
  5. Select the file node.
  6. Click the Manage Users button from the Edit Realm page.
  7. The File Users page displays. In this page, perform the following tasks:

Adding a User

In the File Users page, add a new user by following these steps:

  1. Click New to add a new user to the file realm.
  2. Enter the following information on the File Users page:
    • User ID (required) - The name of the user.
    • Password (required) - The user's password.
    • Confirm Password (required) - The user's password again, for verification.
    • Group List (optional) - A comma-separated list of the groups to which the user belongs. These groups do not need to be defined elsewhere.
  3. Click OK to add this user to the list of users in the file realm. Click Cancel to quit without saving.

Equivalent asadmin command: create-file-user

Editing a User

In the File Users page, change a user's information by following these steps:

  1. In the User ID column, click the name of the user to be modified.
  2. The Edit File Realm User page displays.

  3. Change the user's password by entering a new password in the Password and Confirm Password fields.
  4. Change the groups to which the user belongs by adding or deleting groups in the Group List field. Separate group names with commas. Groups need not be previously defined.
  5. Click Save to save this user to the list of users in the file realm. Click Close to quit without saving.
Deleting a User

In the File Users page, delete a user by following these steps:

  1. Select the checkbox to the left of the name of the user(s) to be deleted.
  2. Click Delete.
  3. Click Close to return to the Edit Realm page.

Equivalent asadmin command: delete-file-user

Editing the certificate Realm

The certificate realm supports SSL authentication. This realm sets up the user identity in the Application Server's security context, and populates it with user data obtained from cryptographically verified client certificates in the trust-store and keystore files (see "About Certificate Files"the Security chapter of the Administration Guide). Add users to these files using keytool. For more information see The J2EE 1.4 Tutorial chapter titled Security at:

http://java.sun.com/j2ee/1.4/docs/tutorial/doc/index.html

With the certificate realm, J2EE containers handle authorization processing based on each user's Distinguished Name (DN) from his or her certificate. The DN is the name of the entity whose public key the certificate identifies. This name uses the X.500 standard, so it is intended to be unique across the Internet. For more information on keystores and trust-stores, refer to the keytool documentation at:

http://java.sun.com/j2se/1.4.2/docs/tooldocs/solaris/keytool.html

Table 1-10 lists the optional properties for the certificate realm.

Table 14-10 Optional properties for certificate realm

Property

Description

assign-groups

A comma-separated list of group names. All clients who present valid certificates are assigned to these groups. For example, employee,manager, where these are the names of user groups.

jaas-context

Type of login module to use for this realm. For the certificate realm, the value must be certificateRealm.

See also:

Deleting a Realm

To delete a realm, follow these steps.

  1. In the Admin Console tree component, expand the Configurations node.
  2. Select the instance to configure:
    1. To configure a particular instance, select the instance's config node. For example, the default instance, server, select the server-config node.
    2. To configure the default settings for all instances, select the default-config node.
  3. Expand the Security node.
  4. Select the Realms node.
  5. Click in the box beside the realm to be deleted.
  6. Click Delete.

Equivalent asadmin command: delete-auth-realm

See also:

Setting the Default Realm

The default realm is the realm that the Application Server uses for authentication and authorization if an application's deployment descriptor does not specify a realm.

To set the default realm, follow these steps.

  1. In the Admin Console tree component, expand the Configurations node.
  2. Select the instance to configure:
    1. To configure a particular instance, select the instance's config node. For example, the default instance, server, select the server-config node.
    2. To configure the default settings for all instances, select the default-config node.
  3. Select the Security node.
  4. The Security page displays.

  5. In the Default Realm field, pick the desired realm from the drop-down list.
  6. Click Save to save the changes or Load Defaults to delete changes and restore the Application Server default values.
  7. Restart the server if Restart Required displays in the console.

See also:


Admin Console Tasks for JACC Providers

Creating a JACC Provider

JACC (Java Authorization Contract for Containers) is part of the J2EE 1.4 specification that defines an interface for pluggable authorization providers. This enables the administrator to set up third-party plug in modules to perform authorization. By default, the Application Server provides a simple, JACC-compliant file-based authorization engine. For more information, see "Specifying JACC Providers".

To create a JACC provider, follow these steps.

  1. In the Admin Console tree component, expand the Configurations node.
  2. Select the instance to configure:
    1. To configure a particular instance, select the instance's config node. For example, the default instance, server, select the server-config node.
    2. To configure the default settings for all instances, select the default-config node.
  3. Expand the Security node.
  4. Select the JACC Providers node.
  5. On the JACC Providers page, click New.
  6. On the Create JACC Provider page, enter the following:
    • Name - The name to use to identify this provider.
    • Policy Configuration - The name of the class that implements the policy configuration factory. The default provider uses com.sun.enterprise.security.provider.PolicyConfigurationFactoryImpl.
    • Policy Provider - The name of the class that implements the policy factory. The default provider uses com.sun.enterprise.security.provider.PolicyWrapper.
  7. Add properties to the provider by clicking the Add Property button. Valid properties include:
    • repository: the directory that contains the policy file. For the default provider, this value is install_dir/domains/domain_dir/generated/policy.
  8. Click OK to save this configuration, or click Cancel to quit without saving.

See also:

Editing a JACC Provider

To edit a JACC provider, follow these steps.

  1. In the Admin Console tree component, expand the Configurations node.
  2. Select the instance to configure:
    1. To configure a particular instance, select the instance's config node. For example, the default instance, server, select the server-config node.
    2. To configure the default settings for all instances, select the default-config node.
  3. Expand the Security node.
  4. Expand the JACC Providers node.
  5. Select the node of the JACC provider to be edited.
  6. On the Edit JACC Provider page, modify the provider information as desired:
    • Policy Configuration - The name of the class that implements the policy configuration factory.
    • Policy Provider - The name of the class that implements the policy factory.
  7. To add properties, click the Add button. Enter the name and value for the property. Valid entries include:
    • repository: the directory that contains the policy file. For the default provider, this value is install_dir/domains/domain_dir/generated/policy.
  8. To delete an existing property, click in the checkbox to the left of the property, then click Delete Properties.
  9. Click Save to save or click the browser's back button to cancel without saving.

See also:

Deleting a JACC Provider

To delete a JACC provider, follow these steps.

  1. In the Admin Console tree component, expand the Configurations node.
  2. Select the instance to configure:
    1. To configure a particular instance, select the instance's config node. For example, the default instance, server, select the server-config node.
    2. To configure the default settings for all instances, select the default-config node.
  3. Expand the Security node.
  4. Select the JACC Providers node.
  5. Click in the checkbox to the left of the JACC provider to be deleted.
  6. Click Delete.

See also:

Setting the Active JACC Provider

To specify the JACC provider, follow these steps.

  1. In the Admin Console tree component, expand the Configurations node.
  2. Select the instance to configure:
    1. To configure a particular instance, select the instance's config node. For example, the default instance, server, select the server-config node.
    2. To configure the default settings for all instances, select the default-config node.
  3. Select the Security node.
  4. The Security page displays.

  5. In the JACC field, enter the name of the JACC provider to be used by the server. Expand the JACC Provider component to view all configured JACC providers.
  6. Select Save to save the changes or Load Defaults to return to the default values.
  7. Restart the Application Server if Restart Required displays in the console.

See also:


Admin Console Tasks for Audit Modules

Creating an Audit Module

The Application Server provides a simple default audit module; for more information, see "Using the Default Audit Module".

To create a new audit module, follow these steps.

  1. In the Admin Console tree component, expand the Configurations node.
  2. Select the instance to configure:
    1. To configure a particular instance, select the instance's config node. For example, the default instance, server, select the server-config node.
    2. To configure the default settings for all instances, select the default-config node.
  3. Expand the Security node.
  4. Select the Audit Modules node.
  5. On the Audit Modules page, click New.
  6. On the Create Audit Module page, enter the following information:
    • Name - The name used to identify this audit module.
    • Classname - The fully-qualified name of the class that implements this module. The class name for the default audit module is com.sun.enterprise.security.Audit.
  7. To add JVM properties to this module, click Add Property. Specify a name and value for each property. Valid properties include:
    • auditOn - Specifies whether or not to enable this implementation class. Valid values are true and false.
  8. Click OK to save entries, or click Cancel to quit without saving.

See also:

Editing an Audit Module

To edit an audit module, follow these steps.

  1. In the Admin Console tree component, expand the Configurations node.
  2. Select the instance to configure:
    1. To configure a particular instance, select the instance's config node. For example, the default instance, server, select the server-config node.
    2. To configure the default settings for all instances, select the default-config node.
  3. Expand the Security node.
  4. Expand the Audit Modules node.
  5. Click the node of the audit module to be edited.
  6. On the Edit Audit Module page, modify the class name, if needed.
  7. Enter any additional properties for the module by selecting the Add button and entering the name and value of the property. Valid properties include:
    • auditOn - Specifies whether or not to use this audit module. Valid values are true and false.
  8. Modify any existing properties by selecting the name or value to be modified, and entering the changes directly into the text field.
  9. Delete a property by selecting the checkbox to the left of the property and clicking Delete Properties.
  10. Click Save to save or click the Back button on the browser to cancel without saving.

See also:

Deleting an Audit Module

To delete an audit module, follow these steps.

  1. In the Admin Console tree component, expand the Configurations node.
  2. Select the instance to configure:
    1. To configure a particular instance, select the instance's config node. For example, the default instance, server, select the server-config node.
    2. To configure the default settings for all instances, select the default-config node.
  3. Expand the Security node.
  4. Select the Audit Modules node.
  5. Click in the checkbox to the left of the audit module to be deleted.
  6. Click Delete.

See also:

Enabling and Disabling Audit Logging

To specify the audit module that the server uses, follow these steps.

  1. In the Admin Console tree component, expand the Configurations node.
  2. Select the instance to configure:
    1. To configure a particular instance, select the instance's config node. For example, the default instance, server, select the server-config node.
    2. To configure the default settings for all instances, select the default-config node.
  3. Select the Security node.
  4. The Security page displays.

  5. To enable logging, select the Audit Logging check box. To disable it, deselect it. Selecting this option causes the loading of the audit modules and ensures they are called by the Application Server's audit library at audit points.
  6. If you are enabling audit logging, specify a default audit module as described in "Setting the Active Audit Module".
  7. Select Save to save the changes.
  8. Restart the Application Server if Restart Required displays in the console.

See also:

Setting the Active Audit Module

To specify the audit module that the server uses, follow these steps.

  1. In the Admin Console tree component, expand the Configurations node.
  2. Select the instance to configure:
    1. To configure a particular instance, select the instance's config node. For example, the default instance, server, select the server-config node.
    2. To configure the default settings for all instances, select the default-config node.
  3. Select the Security node.
  4. The Security page displays.

  5. In the Audit Modules field, enter the name of the audit module to be used by the server. (The preconfigured audit module is called default.)
  6. Select Save to save the changes, Load Defaults to cancel.
  7. Restart the Application Server if Restart Required displays in the console.

Using the Default Audit Module

The default audit module logs authentication and authorization requests to the server log file. For information on changing the location of the log file, see "Configuring General Logging Settings".

Authentication log entries include the following information:

Regardless of whether audit logging is enabled, the Application Server logs all denied authentication events.

Authorization log entries include the following information:

Enabling and Disabling the Default Audit Module

In addition to enabling logging, set any properties required by the specific audit modules required. In the case of the default audit module, follow these steps.

  1. In the Admin Console tree component, expand the Configurations node.
  2. Select the instance to configure:
    1. To configure a particular instance, select the instance's config node. For example, the default instance, server, select the server-config node.
    2. To configure the default settings for all instances, select the default-config node.
  3. Expand the Security node.
  4. Expand the Audit Modules node.
  5. Click the default node.
  6. Set the value of the auditOn property to true.
  7. Select Save to save the changes.
  8. Restart the Application Server if Restart Required displays in the console.

See also:


Admin Console Tasks for Message Security

The Application Server provides a default message security configuration for the SOAP authentication layer. Modify this configuration and/or add new message security providers to this configuration. For more information, see "Configuring Message Security".

Creating a Message Security Configuration

The Application Server provides a default message security configuration for the SOAP authentication layer. Modify this configuration and/or add new message security providers to this configuration, as needed. For more information, see "Configuring Message Security".

To create a new message security configuration, follow these steps.

  1. In the Admin Console tree component, expand the Configurations node.
  2. Select the instance to configure:
    1. To configure a particular instance, select the instance's config node. For example, the default instance, server, select the server-config node.
    2. To configure the default settings for all instances, select the default-config node.
  3. Expand the Security node in the Admin Console tree.
  4. Select the Message Security node.
  5. On the Message Security Configuration page, click New.
  6. On the Create Message Security Configuration page, enter the following:
    • Authentication Layer - Enter SOAP for the name of the message layer on which authentication processing must be performed. SOAP is the only valid option in this release.
    • Default Provider - Check the box beside this field to make the new message security provider the default for this server.
    • Provider Type - Select client, server, or client-server to establish whether the provider is to be used as a client authentication provider, a server authentication provider, or both (a client-server provider). The default value is client-server.
    • Provider ID - Enter an identifier used to reference this provider configuration in the Admin Console tree.
    • Class Name - Enter the Java implementation class of the provider. Client authentication providers must implement the com.sun.xml.wss.provider.ClientSecurityAuthModule
      interface. Server-side providers must implement the com.sun.xml.wss.provider.ServerSecurityAuthModule
      interface. A provider can implement both interfaces, but it must implement the interface corresponding to its provider type.
  7. Add additional properties by clicking the Add Property button. Valid properties include:
    • server.config - The directory and file name of an XML file that contains the server configuration information. For the default provider, this value is install_dir/domain_dir/config/wss-server-config.xml.
  8. Click OK to save this configuration, or click Cancel to quit without saving.

See also:

Creating a Message Security Provider

To create a new message security provider, follow these steps.

  1. In the Admin Console tree component, expand the Configurations node.
  2. Select the instance to configure:
    1. To configure a particular instance, select the instance's config node. For example, the default instance, server, select the server-config node.
    2. To configure the default settings for all instances, select the default-config node.
  3. Expand the Security node.
  4. Select the Message Security node.
  5. Select the node for the Authentication Layer on which to place the message security provider, for example, SOAP.
  6. From the Edit Message Security Configuration page, select the Providers tab.
  7. On the Provider Configuration page, click New.
  8. In the Provider Config section of the Create a Provider Configuration page, enter the following:
    • Default Provider - Check the box beside this field to make the new message security provider the default for this server.
    • Provider Type - Select client, server, or client-server to establish whether the provider is to be used as a client authentication provider, a server authentication provider, or both (a client-server provider). The default value is client-server.
    • Provider ID - Enter a provider configuration identifier in the Admin Console tree.
    • Class Name - Enter the Java implementation class of the provider. Client authentication providers must implement the com.sun.xml.wss.provider.ClientSecurityAuthModule
      interface. Server-side providers must implement the com.sun.xml.wss.provider.ServerSecurityAuthModule
      interface. A provider may implement both interfaces, but it must implement the interface corresponding to its provider type.
  9. In the Request Policy section of the Create a Provider Configuration page, enter the following optional values, if needed. These properties are optional, but if not specified, no authentication is applied to request messages.
    • Authentication Source - Select sender, content, or null (the blank option) to define a requirement for message-layer sender authentication (for example, username password), content authentication (for example, digital signature), or no authentication be applied to request messages. When null is specified, source authentication of the request is not required.
    • Authentication Recipient - Select beforeContent or afterContent to define a requirement for message-layer authentication of the receiver of the request message to its sender (e.g. by XML encryption). When the value is not specified it defaults to afterContent.
  10. In the Response Policy section of the Create a Provider Configuration page, enter the following optional properties, if needed. These properties are optional, but if not specified, no authentication is applied to response messages.
    • Authentication Source - Select sender, content, or null (the blank option) to define a requirement for message-layer sender authentication (for example, username password) or content authentication (for example, digital signature) to be applied to response messages. When null is specified, source authentication of the response is not required.
    • Authentication Recipient - Select beforeContent or afterContent to define a requirement for message-layer authentication of the receiver of the response message to its sender (e.g. by XML encryption). When the value is not specified it defaults to afterContent.
  11. Add additional properties by clicking the Add Property button. The provider that is shipped with the Application Server supports the property listed below. If other providers are used, they can require unique properties. In that case, review that provider's documentation for more information on its properties and valid values.
    • server.config - The directory and file name of an XML file that contains the server configuration information. For the default provider, this value is install_dir/domains/domain_dir/config/wss-server-config.xml.
  12. Click OK to save this configuration, or click Cancel to quit without saving.

Equivalent asadmin command: create-message-security-provider

See also:

Editing a Message Security Configuration

To edit existing information or provide additional information on the provider, follow these steps.

  1. In the Admin Console tree component, expand the Configurations node.
  2. Select the instance to configure:
    1. To configure a particular instance, select the instance's config node. For example, the default instance, server, select the server-config node.
    2. To configure the default settings for all instances, select the default-config node.
  3. Expand the Security node.
  4. Expand the Message Security node.
  5. Select the SOAP node.
  6. Select the Message Security tab for that node.
  7. On the Edit Message Security Configuration page, modify the following optional properties, as needed:
    • Default Provider - The identify of the server provider to be invoked for any application for which a specific server provider has not been bound. Optionally, select the pre-defined ClientProvider, ServerProvider, or a provider that was created following the steps in "Creating a Message Security Provider".
    • Default Client Provider - The identify of the client provider to be invoked for any application for which a specific client provider has not been bound. Optionally, select the pre-defined ClientProvider, ServerProvider, or a provider that was created following the steps in "Creating a Message Security Provider".
  8. Click Save.
  9. Select the Providers tab.
  10. Select the message security provider to edit.
  11. In the Provider Config section of the Edit Provider Config page, the following properties are available for modification:
    • Provider Type - Select client, server, or client-server to establish whether the provider is to be used as a client authentication provider, a server authentication provider, or both (a client-server provider). The default value is client-server.
    • Class Name - Enter the Java implementation class of the provider. Client authentication providers must implement the com.sun.xml.wss.provider.ClientSecurityAuthModule
      interface. Server-side providers must implement the com.sun.xml.wss.provider.ServerSecurityAuthModule
      interface. A provider might implement both interfaces, but it must implement the interface corresponding to its provider type.
  12. In the Request Policy section of the Edit Provider Config page, enter the following optional properties. These properties are optional, but if not specified, no authentication is applied to request messages.
    • Authentication Source - Select sender, content, or null (the blank option) to define a requirement for message-layer sender authentication (for example, username password) or content authentication (for example, digital signature) to be applied to request messages. When null is specified, source authentication of the request is not required.
    • Authentication Recipient - Select beforeContent or afterContent to define a requirement for message-layer authentication of the receiver of the request message to its sender (e.g. by XML encryption). When the value is not specified it defaults to afterContent.
  13. In the Response Policy section of the Edit Provider Config page, enter the following optional properties. These properties are optional, but if not specified, no authentication is applied to response messages.
    • Authentication Source - Select sender, content, or null (the blank option) to define a requirement for message-layer sender authentication (for example, username password) or content authentication (for example, digital signature) to be applied to response messages. When null is specified, source authentication of the response is not required.
    • Authentication Recipient - Select beforeContent or afterContent to define a requirement for message-layer authentication of the receiver of the response message to its sender (an example is, by XML encryption). When the value is not specified it defaults to afterContent.
  14. Add additional properties by clicking the Add Property button. The provider that is shipped with the Application Server supports the property listed below. If other providers are used, they may require unique properties. In that case, review that provider's documentation for more information on its properties and valid values.
    • server.config - The directory and file name of an XML file that contains the server configuration information. For the default provider, this value is install_dir/domains/domain_dir/config/wss-server-config.xml.
  15. Click Save.

Helpful asadmin command: list-message-security-providers

See also:

Deleting a Message Security Configuration

To delete a message security configuration, follow these steps.

  1. In the Admin Console tree component, expand the Configurations node.
  2. Select the instance to configure:
    1. To configure a particular instance, select the instance's config node. For example, the default instance, server, select the server-config node.
    2. To configure the default settings for all instances, select the default-config node.
  3. Expand the Security node.
  4. Select the Message Security node.
  5. Click in the checkbox to the left of the Message Security Configuration to be deleted.
  6. Click Delete.

See also:

Deleting a Message Security Provider

To delete a message security provider, follow these steps.

  1. In the Admin Console tree component, expand the Configurations node.
  2. Select the instance to configure:
    1. To configure a particular instance, select the instance's config node. For example, the default instance, server, select the server-config node.
    2. To configure the default settings for all instances, select the default-config node.
  3. Expand the Security node.
  4. Expand the Message Security node.
  5. Select the node for the authentication layer that contains the provider to be deleted.
  6. From the Message Security page, select the Providers page.

  7. Click in the checkbox to the left of the Provider Configuration to be deleted.
  8. Click Delete.

Equivalent asadmin command: delete-message-security-provider

See also:


Admin Console Tasks for Listeners

Configuring Security for HTTP Listeners

Each virtual server in the HTTP service provides network connections through one or more HTTP listeners. With the Admin Console, create new HTTP listeners and edit the security settings of existing HTTP listeners.

To edit security settings for an existing HTTP listener, follow these steps.

  1. In the Admin Console tree component, expand the Configurations node.
  2. Select the instance to configure:
    1. To configure a particular instance, select the instance's config node. For example, the default instance, server, select the server-config node.
    2. To configure the default settings for all instances, select the default-config node.
  3. Expand the HTTP Service node.
  4. Select the HTTP Listeners node.
  5. Click the name of the HTTP listener.
  6. Alternatively, to create a new listener, click New and follow the procedure in "Creating an HTTP Listener".

  7. Follow the procedure in "Setting Listener Security Properties" to set security properties.
  8. Click Save to save the changes, or click Load Defaults to restore the listener to its default values.

Equivalent asadmin command: create-http-listener

See also:

Configuring Security for IIOP Listeners

The Application Server supports CORBA (Common Object Request Broker Architecture) objects, which use the Internet Inter-Orb Protocol (IIOP) to communicate across the network. An IIOP listener accepts incoming connections from remote clients of EJBs and from other CORBA-based clients. With the Admin Console, create new IIOP listeners and edit the settings of existing IIOP listeners.

To edit security properties for an IIOP listener, follow these steps.

  1. In the Admin Console tree component, expand the Configurations node.
  2. Select the instance to configure:
    1. To configure a particular instance, select the instance's config node. For example, the default instance, server, select the server-config node.
    2. To configure the default settings for all instances, select the default-config node.
  3. Expand the ORB node.
  4. Select the IIOP Listeners node.
  5. Click the name of the IIOP listener.
  6. Alternatively, to create a new listener, click New and follow the procedure in "Creating an IIOP Listener".

  7. Follow the procedure in "Setting Listener Security Properties" to set security properties.
  8. Click Save to save the changes, or click Load Defaults to restore the properties to their default values.

If new listener was created, it will now be listed in the Current Listeners table on the IIOP Listeners page.

Equivalent asadmin command: create-iiop-listener

See also:

Configuring Security for the Admin Service's JMX Connector

To edit security properties for a JMX Connector in the Admin Service, follow these steps.

  1. In the Admin Console tree component, expand the Configurations node.
  2. Select the instance to configure:
    1. To configure a particular instance, select the instance's config node. For example, the default instance, server, select the server-config node.
    2. To configure the default settings for all instances, select the default-config node.
  3. Expand the Admin Service node.
  4. Select the admin service to be modified.
  5. Follow the procedure in "Setting Listener Security Properties" to set security properties.
  6. Click Save to save the changes, or click Load Defaults to restore the properties to their default values.

Setting Listener Security Properties

Follow this common procedure for setting HTTP listener, IIOP listener, and JMX Connector security properties:

  1. In the Edit HTTP Listener, Edit IIOP Listener, or Edit JMX Connector page, go to the section labeled Security.
  2. Check the Enabled box in the Security field. When this option is selected, you must select SSL3 or TLS to specify which type of security is enabled, and you must enter a certificate nickname.
  3. If clients are to authenticate themselves to the Application Server when using this listener, check the Enabled box in the Client Authentication field.
  4. In the Certificate Nickname field, enter the keystore alias, which is a single value that identifies an existing server keypair and certificate. The certificate nickname for the default keystore is s1as.
  5. To find the Certificate Nickname use keytool, as shown in the following example:
    keytool -list -v -keystore keystore.jks.

  1. In the SSL3/TLS section:
    1. Disable SSL3 or TLS if needed, but you must enable at least one. By default, both SSL3 and TLS are enabled.
    2. Enable individual cipher suites, if needed. By default, all supported cipher suites are enabled. Ciphers are discusses in "About Ciphers".
  2. Select Save to save the changes or Load Defaults to cancel.

Securing CORBA Objects

AUTHOR NOTE: Oops! Putting this line in server.policy causes server to fail to start!!

CORBA objects include Java RMI-IIOP and Java IDL or POA-based CORBA objects, excluding EJB modules. By default, authentication is not required for CORBA objects.

To secure CORBA objects:

  1. Configure authentication, if desired.
    1. Expand the ORB node, and then the IIOP Listeners node.
    2. Click the SSL listener.
    3. Select the Security Enabled checkbox.
    4. Click Save.
    5. Restart the Application Server.
    6. Once authentication is turned on, all clients need to authenticate by supplying a user name and password (if using basic authentication) or a certificate (if using SSL mutual authentication).

  2. Configure authorization.
  3. To turn on authorization for CORBA objects, specify the appropriate security policy in the server's security configuration file, install_dir/domains/domain_name/config/server.policy

    By default, all users are allowed to access all non-EJB CORBA objects in the server, as specified by the following default grant block:

    grant { permission com.sun.enterprise.security.CORBAObjectPermission "*", "*"; }

    CORBAObjectPermission is a special Java Permission class that controls which users are allowed to access non-EJB CORBA objects in the server. CORBAObjectPermission takes two parameters:

    1. A CORBA object name; in the Application Server, only the name "*" is supported, that is, it is not possible to specify a specific CORBA object name.
    2. A comma-separated list of method names; in the Application Server, only "*" is supported, that is, it is not possible to specify a specific method name.
    3. The general form of a CORBAObjectPermission grant block is:

      grant principal principal-class-name "principal-name" { permission com.sun.enterprise.security.CORBAObjectPermission "*", "*"; }

      where the principal-class-name is either:

    4. com.sun.enterprise.deployment.PrincipalImpl (for a single principal)
    5. com.sun.enterprise.deployment.Group (for a named group of principals)
  4. Configure message protection:
  5. Integrity and confidentiality of IIOP messages used in requests and replies during CORBA invocations can be protected by using SSL. By default, the server supports both plain IIOP and IIOP-over-SSL invocations.

    1. To force clients to use only SSL for IIOP invocations, remove all non-SSL iiop-listener elements in the iiop-service element in domain.xml.
    2. This ensures that the server will not service plain IIOP invocations. By default, application clients use plain IIOP for making requests if the server supports plain IIOP.

    3. To force the client to use SSL, a change is needed in the application client configuration file sun-acc.xml (which is also located in the domain's config directory); specifically, the property ssl with value required should be added inside the <client-container> element, as follows:
    4.    <client-container>
            <property name="ssl" value="required"/>
            <target-server .... />
         </client-container>


Admin Console Tasks for Connector Connection Pools

About Connector Connection Pools

A connector module (also called a resource adapter) enables J2EE applications to interact with enterprise information systems (EIS). A connector resource provides an application with a connection to an EIS. A connector connection pool is a group of reusable connections for a particular EIS.

Security maps enables the creation of a mapping between J2EE users and groups and EIS users and groups. Use the Admin Console to create, update, list, and delete security maps for connector connection pools.

Note: In this context, users are referred to as principals. The enterprise information system (EIS) is any system that holds the information. It can be a mainframe, a messaging system, a database system, or an application.

See also:

About Security Maps

Use security maps to map the caller identity of the application (principal or user group) to a suitable EIS principal in container-managed transaction-based scenarios. When an application principal initiates a request to an EIS, the application server first checks for an exact principal using the security map defined for the connector connection pool to determine the mapped backend EIS principal. If there is no exact match, then the application server uses the wild card character specification, if any, to determine the mapped backend EIS principal. Security maps are used when an application user needs to execute EIS operations that require to be executed as a specific identity in the EIS.

See also:

Creating a Security Map

A security map for a connector connection pool maps application users and groups (principals) to EIS principals. Use a security map when an application user needs to execute EIS operations that require a specific identity in the EIS.

To create a security map for a given connector connection pool, follow these steps.

  1. Expand the Resources node.
  2. Expand the Connectors node.
  3. Select the Connector Connection Pools node.
  4. Select a Connector Connection Pool by selecting its name from the list of current pools or create a new connector connection pool by selecting New from the list of current pools and following the instructions in "Creating a Connector Connection Pool".
  5. Select the Security Maps page.
  6. Click New to create a new Security Map.
  7. On the Create Security Map page, enter the following properties.
    • Name - Enter a name to be used to reference this particular security map.
    • User Groups - The caller identity of the application to be mapped to a suitable EIS principal. Enter a comma-separated list of application-specific user groups, or enter the wild card asterisk (*) to indicate all users or all user groups. Specify either the Principals or User Groups options, but not both.
    • Principals - The caller identity of the application to be mapped to a suitable EIS principal. Enter a comma-separated list of application-specific principals, or enter the wild card asterisk (*) to indicate all principals. Specify either the Principals or User Groups options, but not both.
  8. In the Backend Principal section, enter the following properties.
    • Username - Enter the EIS user name. The enterprise information system (EIS) is any system that holds the information. It can be a mainframe, a messaging system, a database system, or an application.
    • Password - Enter the password for the EIS user.
  9. Click OK to create the security map.

Equivalent asadmin command: create-connector-security-map

See also:

Editing a Security Map

To modify a security map for a given connector connection pool, follow these steps.

  1. Expand the Resources node.
  2. Expand the Connectors node.
  3. Select the Connector Connection Pools node.
  4. Select a Connector Connection Pool by selecting its name from the list of current pools.
  5. Select the Security Maps page.
  6. On the Security Maps page, select a security map from the list of current security maps.
  7. On the Edit Security Map page, modify the following properties where needed.
    • User Groups - The caller identity of the application to be mapped to a suitable EIS principal. Enter a comma-separated list of application-specific user groups, or enter the wild card asterisk (*) to indicate all users or all user groups. Specify either the Principals or User Groups options, but not both.
    • Principals - The caller identity of the application to be mapped to a suitable EIS principal. Enter a comma-separated list of application-specific principals, or enter the wild card asterisk (*) to indicate all principals. Specify either the Principals or User Groups options, but not both.
  8. In the Backend Principal section, enter the following properties.
    • Username - Enter the EIS user name. The enterprise information system (EIS) is any system that holds the information. It can be a mainframe, a messaging system, a database system, or an application.
    • Password - Enter the password for the EIS user.
  9. Click Save to save the changes to the security map.

Helpful asadmin command: list-connector-security-maps, update-connector-security-maps

See also:

Deleting a Security Map

To delete a security map for a given connector connection pool, follow these steps.

  1. Expand the Resources node.
  2. Expand the Connectors node.
  3. Select the Connector Connection Pools node.
  4. Select a Connector Connection Pool by selecting its name from the list of current pools.
  5. Select the Security Maps page.
  6. On the Security Maps page, click the checkbox to the left of the name of the security map to be deleted.
  7. Click Delete.

Equivalent asadmin command: delete-connector-security-map

See also:


Working with Certificates and SSL

About Certificate Files

Installation of the Application Server generates a digital certificate suitable for internal testing. By default, the Application Server stores its certificate information in two files in the install_dir/domains/domain_name/config directory:

See also:

Changing the Location of Certificate Files

The keystore and trust-store files provided for development are stored in the install_dir/domains/domain_name/config directory. To change the name and/or location of the keystore and trust-store files, follow these steps.

  1. In the Admin Console tree, select the Application Server node expand Configurations.
  2. Expand the server-config (Admin Config) node.
  3. Select the JVM Settings node.
  4. Click the JVM Options tab.
  5. On the JVM Options page, add or modify the following values in the Value field to reflect the new location of the certificate files:
  6. -Djavax.net.ssl.keyStore=${com.sun.aas.instanceRoot}/path/ks_name
    -Djavax.net.ssl.trustStore=${com.sun.aas.instanceRoot}/path/ts_name

    where ks_name is the keystore file name and ts_name is the trust-store file name.

  7. Click Save.
  8. Restart the Application Server if Restart Required displays in the console.

See also:

About Keytool

Use keytool to set up and work with digital certificates. The J2SE SDK ships with keytool, thus allowing the adminiatrator to administer public/private key pairs and associated certificates. It also enables users to cache the public keys (in the form of certificates) of their communicating peers.

To run keytool, the shell environment must be configured so that the J2SE /bin directory is in the path, or the full path to the tool must be present on the command line. For more information on keytool, see the keytool documentation at:

http://java.sun.com/j2se/1.4.2/docs/tooldocs/solaris/keytool.html

Generating a Server Certificate

Use keytool to generate, import, and export certificates. By default, keytool creates a keystore file in the directory where it is run.

To generate a server certificate:

  1. Change to the directory where the server certificate is to be run.
  2. Always generate the certificate in the directory containing the server's keystore and trust-store files, by default install_dir/domains/domain_name/config. For information on changing the location of these files, see "Changing the Location of Certificate Files".

  3. Enter the following keytool command to generate the server certificate in the keystore file, keystore.jks:
  4. keytool -genkey -alias keyAlias
    -keyalg RSA
    -keypass changeit
    -storepass changeit
    -keystore keystore.jks
  1. Enter the following keytool command to export the generated server certificate to the file server.cer:
  2. keytool -export -alias keyAlias
    -storepass changeit
    -file server.cer
    -keystore keystore.jks
  3. If a certificate signed by a certificate authority is required, see "Signing a Digital Certificate" for more information.
  4. To create the trust-store file cacerts.jks and add the server certificate to the trust-store, enter the following keytool command:
  5. keytool -import -v -trustcacerts
    -alias keyAlias
    -file server.cer
    -keystore cacerts.jks
    -keypass changeit
  1. Type yes, then press Enter.
  2. Then keytool displays something like this:

    Certificate was added to keystore
    [Saving cacerts.jks]
  3. Restart the Application Server.

For complete information about using keytool, see the keytool documentation at:

http://java.sun.com/j2se/1.4.2/docs/tooldocs/solaris/keytool.html

Signing a Digital Certificate

After creating a digital certificate, the owner must sign it to prevent forgery. E-commerce sites, or those for which authentication of identity is important can purchase a certificate from a well-known Certificate Authority (CA). If authentication is not a concern, for example if private secure communications is all that is required, save the time and expense involved in obtaining a CA certificate and use a self-signed certificate.

Using a Certificate From a CA

To use a digital certificate signed by a CA:

  1. Follow the instructions on the CA's Web site for generating certificate key pairs.
  2. Download the generated certificate key pair.
  3. Save the certificate in the directory containing the server keystore and trust-store files, by default install_dir/domains/domain-dir/config directory. See "Changing the Location of Certificate Files" for instructions on changing this location.

  4. In your shell, change to the directory containing the certificate.
  5. Use keytool to import the certificate into thelocal keystore and, if necessary, the local trust-store.
  6. keytool -import -v -trustcacerts
    -alias keyAlias
    -file server.cer
    -keystore cacerts.jks
    -keypass changeit
    -storepass changeit
  1. Restart the Application Server.

For complete information about using keytool, see the keytool documentation at:

http://java.sun.com/j2se/1.4.2/docs/tooldocs/solaris/keytool.html

Deleting a Certificate

To delete an existing certificate, use the keytool -delete command, for example:

keytool -delete
-alias keyAlias
-keystore keystore_name
-storepass password

For a complete list of possible options for the -delete command, refer to the keytool documentation at:

http://java.sun.com/j2se/1.4.2/docs/tooldocs/solaris/keytool.html

Verifying SSL

TBD

Previous      Contents      Index      Next     


Copyright 2004 Sun Microsystems, Inc. All rights reserved.