...
For each Subject accessible through a credential store you need to specify an id, the realm to log in to, and credentials, which depend on the security realm requirements but are typically the name and password. The schema is as follows:
| Wiki Markup |
|---|
{snippet:url=geronimo/server/branches/2.1/plugins/j2ee/geronimo-security-builder/src/main/xsd/geronimo-credential-store-1.0.xsd|lang=xml} |
At the moment Geronimo supplies callback handlers for name and password. For other security realm requirements (e.g. certificates) you will have to write a callback handler.
A simple example of credential store configuration would look like this:
| Code Block | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
<gbean name="CredentialStore" class="org.apache.geronimo.security.credentialstore.SimpleCredentialStoreImpl"> | ||||||||
| Code Block | ||||||||
| XML | XML | |||||||
| borderStyle | solid | |||||||
| title | Standard Credential Store xml Configuration Schema | <xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:cs="http://geronimo.apache.org/xml/ns/credentialstore-1.0" targetNamespace="http://geronimo.apache.org/xml/ns/credentialstore-1.0" elementFormDefault="qualified" attributeFormDefault="unqualified" version<xml-attribute name="1.0credentialStore"> <xsd:annotation> <xsd:documentation><credential-store xmlns="http://geronimo.apache.org/xml/ns/credentialstore-1.0"> This is an XML Schema Definition for credential store configuration. <realm name="my-properties-realm"> CredentialStore configuration is<subject> specified by the element credential-store with namespace <id>admin-run-as</id> specified as xmlns = "http://geronimo.apache.org/xml/ns/credentialstore-1.0".<credential> </xsd:documentation> </xsd:annotation> <xsd:element name="credential-store" type="cs:credential-storeType"> <xsd:annotation><type>org.apache.geronimo.security.credentialstore.NameCallbackHandler</type> <xsd:documentation> The<value>system</value> root element for Geronimo credential store configuration. This is</credential> a tree structure of realm, id, and sets of credentials such as name and password <credential> </xsd:documentation> </xsd:annotation> </xsd:element> <xsd:complexType name="credential-storeType"> <xsd:annotation><type>org.apache.geronimo.security.credentialstore.PasswordCallbackHandler</type> <xsd:documentation> Defines<value>manager</value> the list of realms </xsd:documentation> </xsd:annotation>credential> <xsd:sequence> <xsd:element name="realm" type="cs:realmType" minOccurs="0" maxOccurs="unbounded"> </subject> <xsd:annotation><subject> <xsd:documentation> <id>user-run-as</id> The realm element<credential> contains the credentials for subjects in that realm. </xsd:documentation><type>org.apache.geronimo.security.credentialstore.NameCallbackHandler</type> </xsd:annotation> <<value>user</xsd:element>value> </xsd:sequence> </xsd:complexType> <xsd:complexType name="realmType"> <xsd:sequence></credential> <xsd:element name="subject" type="cs:subjectType" minOccurs="0" maxOccurs="unbounded"/> </xsd:sequence><credential> <xsd:attribute name="name" type="xsd:string" use="required"> <xsd:annotation> <type>org.apache.geronimo.security.credentialstore.PasswordCallbackHandler</type> <xsd:documentation> <value>user-password</value> The name attribute specifies the login realm name </xsd:documentation>credential> </xsd:annotation> </xsd:attribute>subject> </xsd:complexType> <xsd:complexType name="subjectType"> <xsd:sequence> <subject> <xsd:element name="id" type="xsd:string"> <id>default</id> <xsd:annotation> <xsd:documentation><credential> The id element serves to identify the subject externally. For subjects with meaningful <type>org.apache.geronimo.security.credentialstore.NameCallbackHandler</type> <value>default</value> names it might be convenient to use the name as id. </credential> </xsd:documentation><credential> </xsd:annotation> </xsd:element><type>org.apache.geronimo.security.credentialstore.PasswordCallbackHandler</type> <xsd:element name="credential" type="cs:credentialType" minOccurs="0" maxOccurs="unbounded"/> </xsd:sequence> </xsd:complexType> <value>default</value> <xsd:complexType name="credentialType"> <xsd:sequence> <xsd:element name="type" type="xsd:string"></credential> <xsd:annotation> </subject> <xsd:documentation></realm> Class name or alias of the callback handler that will accept this credential</credential-store> </xml-attribute> </xsd:documentation> </xsd:annotation> </xsd:element> <xsd:element name="value" type="xsd:string"> <xsd:annotation> <xsd:documentation> credential value as a string. </xsd:documentation> </xsd:annotation> </xsd:element> </xsd:sequence> </xsd:complexType> </xsd:schema> |
At the moment Geronimo supplies callback handlers for name and password. For other security realm requirements (e.g. certificates) you will have to write a callback handler.
A simple example of credential store configuration would look like this:
...
gbean>
|
Again, note that the PasswordCallbackHandler value element contains a plaintext password for the user.
Configuring your application to use a particular CredentialStore
Note that this aspect of geronimo security is completely pluggable and only the default implementation is described here.
Geronimo security for JavaEE applications requires including a <security> element in (one of) the geronimo plans for your application. This describes the principal-role mappings to connect the Subjects from your security realm to the roles used in the spec deployment descriptors (and annotations). It also describes how to interpret run-as roles as subjects through specifying a credential store and the id and realm for each role used as a run-as. Similarly a default subject can be specified in the credential store.
The schema for security configuration is as follows:
| Wiki Markup |
|---|
{snippet:url=geronimo/server/branches/2.1/plugins/j2ee/geronimo-security-builder/src/main/xsd/geronimo-security-2.0.xsd|lang=xml} |
...
<gbean name="CredentialStore" class="org.apache.geronimo.security.credentialstore.SimpleCredentialStoreImpl">
<xml-attribute name="credentialStore">
<credential-store xmlns="http://geronimo.apache.org/xml/ns/credentialstore-1.0">
<realm name="my-properties-realm">
<subject>
<id>admin-run-as</id>
<credential>
<type>org.apache.geronimo.security.credentialstore.NameCallbackHandler</type>
<value>system</value>
</credential>
<credential>
<type>org.apache.geronimo.security.credentialstore.PasswordCallbackHandler</type>
<value>manager</value>
</credential>
</subject>
<subject>
<id>user-run-as</id>
<credential>
<type>org.apache.geronimo.security.credentialstore.NameCallbackHandler</type>
<value>user</value>
</credential>
<credential>
<type>org.apache.geronimo.security.credentialstore.PasswordCallbackHandler</type>
<value>user-password</value>
</credential>
</subject>
<subject>
<id>default</id>
<credential>
<type>org.apache.geronimo.security.credentialstore.NameCallbackHandler</type>
<value>default</value>
</credential>
<credential>
<type>org.apache.geronimo.security.credentialstore.PasswordCallbackHandler</type>
<value>default</value>
</credential>
</subject>
</realm>
</credential-store>
</xml-attribute>
</gbean>
Again, note that the PasswordCallbackHandler value element contains a plaintext password for the user.
Configuring your application to use a particular CredentialStore
Note that this aspect of geronimo security is completely pluggable and only the default implementation is described here.
Geronimo security for JavaEE applications requires including a <security> element in (one of) the geronimo plans for your application. This describes the principal-role mappings to connect the Subjects from your security realm to the roles used in the spec deployment descriptors (and annotations). It also describes how to interpret run-as roles as subjects through specifying a credential store and the id and realm for each role used as a run-as. Similarly a default subject can be specified in the credential store.
The schema for security configuration is as follows:
| Code Block | |
|---|---|
| XML | XML |
| borderStyle | solid |
| title | Application Security Configuration Schema |
<xsd:schema
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:j2ee="http://java.sun.com/xml/ns/j2ee"
xmlns:geronimo="http://geronimo.apache.org/xml/ns/security-2.0"
targetNamespace="http://geronimo.apache.org/xml/ns/security-2.0"
xmlns:app="http://geronimo.apache.org/xml/ns/j2ee/application-2.0"
xmlns:sys="http://geronimo.apache.org/xml/ns/deployment-1.2"
elementFormDefault="qualified"
attributeFormDefault="unqualified"
version="2.0">
<xsd:import namespace="http://www.w3.org/XML/1998/namespace" schemaLocation="http://www.w3.org/2001/xml.xsd"/>
<xsd:import namespace="http://geronimo.apache.org/xml/ns/j2ee/application-2.0" schemaLocation="geronimo-application-2.0.xsd"/>
<xsd:import namespace="http://geronimo.apache.org/xml/ns/deployment-1.2" schemaLocation="geronimo-module-1.2.xsd"/>
<xsd:element name="security" type="geronimo:securityType" substitutionGroup="app:security"/>
<xsd:element name="credential-store" type="sys:patternType"/>
<xsd:element name="default-subject" type="geronimo:subject-infoType"/>
<xsd:complexType name="securityType">
<xsd:annotation>
<xsd:documentation>
Security entries
If this element is present, all web and EJB modules MUST make the
appropriate access checks as outlined in the JACC spec.
</xsd:documentation>
</xsd:annotation>
<xsd:complexContent>
<xsd:extension base="app:abstract-securityType">
<xsd:sequence>
<xsd:element name="description" type="geronimo:descriptionType" minOccurs="0"
maxOccurs="unbounded"/>
<xsd:element name="credential-store-ref" type="sys:patternType" minOccurs="0"/>
<xsd:element name="default-subject" type="geronimo:subject-infoType" minOccurs="0"/>
<xsd:element name="role-mappings" type="geronimo:role-mappingsType" minOccurs="0"/>
</xsd:sequence>
<xsd:attribute name="doas-current-caller" type="xsd:boolean" default="false">
<xsd:annotation>
<xsd:documentation>
Set this attribute to "true" if the work is to be performed
as the calling Subject.
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
<xsd:attribute name="use-context-handler" type="xsd:boolean" default="false">
<xsd:annotation>
<xsd:documentation>
Set this attribute to "true" if the installed JACC policy
contexts will use PolicyContextHandlers.
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
<xsd:attribute name="default-role" type="xsd:string">
<xsd:annotation>
<xsd:documentation>
Used by the the Deployer to assign method permissions for
all of the unspecified methods, either by assigning them
to security roles, or by marking them as unchecked. If
the value of default-role is empty, then the unspecified
methods are marked unchecked
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
</xsd:extension>
</xsd:complexContent>
</xsd:complexType>
<xsd:complexType name="descriptionType">
<xsd:simpleContent>
<xsd:extension base="xsd:string">
<xsd:attribute ref="xml:lang"/>
</xsd:extension>
</xsd:simpleContent>
</xsd:complexType>
<xsd:complexType name="named-username-password-credentialType">
<xsd:sequence>
<xsd:element name="name" type="xsd:string"/>
<xsd:element name="username" type="xsd:string"/>
<xsd:element name="password" type="xsd:string"/>
</xsd:sequence>
</xsd:complexType>
<xsd:complexType name="role-mappingsType">
<xsd:sequence>
<xsd:element name="role" type="geronimo:roleType" minOccurs="1" maxOccurs="unbounded"/>
</xsd:sequence>
</xsd:complexType>
<xsd:complexType name="roleType">
<xsd:sequence>
<xsd:element name="description" type="geronimo:descriptionType" minOccurs="0" maxOccurs="unbounded"/>
<xsd:element name="run-as-subject" type="geronimo:subject-infoType" minOccurs="0"/>
<xsd:element name="realm-principal" type="geronimo:realmPrincipalType" minOccurs="0" maxOccurs="unbounded"/>
<xsd:element name="login-domain-principal" type="geronimo:loginDomainPrincipalType" minOccurs="0"
maxOccurs="unbounded"/>
<xsd:element name="principal" type="geronimo:principalType" minOccurs="0" maxOccurs="unbounded"/>
<xsd:element name="distinguished-name" type="geronimo:distinguishedNameType" minOccurs="0"
maxOccurs="unbounded"/>
</xsd:sequence>
<xsd:attribute name="role-name" type="xsd:string" use="required"/>
</xsd:complexType>
<xsd:complexType name="realmPrincipalType">
<xsd:complexContent>
<xsd:extension base="geronimo:loginDomainPrincipalType">
<xsd:attribute name="realm-name" type="xsd:string" use="required"/>
</xsd:extension>
</xsd:complexContent>
</xsd:complexType>
<xsd:complexType name="loginDomainPrincipalType">
<xsd:complexContent>
<xsd:extension base="geronimo:principalType">
<xsd:attribute name="domain-name" type="xsd:string" use="required"/>
</xsd:extension>
</xsd:complexContent>
</xsd:complexType>
<xsd:complexType name="principalType">
<xsd:sequence>
<xsd:element name="description" type="geronimo:descriptionType" minOccurs="0" maxOccurs="unbounded"/>
</xsd:sequence>
<xsd:attribute name="class" type="xsd:string" use="required"/>
<xsd:attribute name="name" type="xsd:string" use="required"/>
</xsd:complexType>
<xsd:complexType name="distinguishedNameType">
<xsd:sequence>
<xsd:element name="description" type="geronimo:descriptionType" minOccurs="0" maxOccurs="unbounded"/>
</xsd:sequence>
<xsd:attribute name="name" type="xsd:string" use="required"/>
</xsd:complexType>
<xsd:complexType name="subject-infoType">
<xsd:sequence>
<xsd:element name="description" type="geronimo:descriptionType" minOccurs="0" maxOccurs="unbounded"/>
<xsd:element name="realm" type="xsd:string"/>
<xsd:element name="id" type="xsd:string"/>
</xsd:sequence>
</xsd:complexType>
</xsd:schema>
|
The credential store to use is specified in the credential-store-ref. Normally you only need only supply the name component of the credential store name: for most purposes you are likely to include an app specific credential store in the app plan, but otherwise you need to assure that the credential store gbean is in the ancestor configurations of the application.
...