Diseño del estudio - Índice de gráficos

11. Metodología

11.1 Diseño del estudio

The authentication configuration file, authenticationConfig.xml, is in the /server/conf directory of a Worklight project. It is the main file used to configure the Worklight framework security components.

Static web resources, security tests, authentication realms, login modules, and authenticators are properly configured using the authenticationConfig.xml file, which consists of several Worklight security components, as shown in Example 4-1.

Example 4-1 The authenticationConfig.xml file and its XML elements

<?xml version="1.0" encoding="UTF-8"?>

<tns:loginConfiguration xmlns:tns="http://www.worklight.com/auth/config"

xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">

</staticResources>

</securityTests>

</realms>

</loginModules>

</tns:loginConfiguration>

Configure the Worklight framework security components in the server/conf/authenticationConfig.xml file:

򐂰 You can modify them by editing the Extensible Markup Language (XML) file directly.

򐂰 You can modify them by using the graphical user interface (GUI)-based Authentication Configuration Editor in Worklight Studio, as shown in Figure 4-2 on page 45.

Figure 4-2 Authentication Configuration Editor

A file named authenticationConfig.xsd has all of the definitions for each XML element, and the possible parameters allowed when configuring them.

References to those XML element definitions are included in the forthcoming explanations, when applicable, to clarify how to configure them.

The <staticResources> and <resource> XML elements

Use the parent <staticResources> and child <resource> XML elements to restrict access to a web resource.

You must provide an ID for each resource, in addition to the securityTest name that is used to protect the resource.

The child <urlPatterns> element is used to inform the Uniform Resource Locator (URL) pattern that it will be matched against, as shown in Example 4-2.

Example 4-2 The <staticResources> and <resource> XML elements

<urlPatterns>/subscribeSMS*</urlPatterns>

</resource>

...

</staticResources>

For a complete reference about how to configure these elements, see the XML excerpt from authenticationConfig.xsd, as shown in Example 4-3.

Example 4-3 XML element definitions from authenticationConfig.xsd

</sequence>

</complexType>

...

</sequence>

</complexType>

The <securityTests> and <customSecurityTest> XML elements

Use the parent <securityTests> and child <customSecurityTest> XML elements to configure the security tests that will be used to restrict access to protected resources.

You can use the predefined tests that are supplied ready for use for standard web and mobile security requirements, or you can write your own custom security tests and define the sequence in which they are run.

Example 4-4 provides sample configurations for web, mobile, and custom security tests.

Security tests are explained in detail in 4.1.5, “Security tests” on page 68.

Example 4-4 Web, mobile, and custom security tests

</customSecurityTest>

For a complete reference about how to configure these elements, see the XML excerpt from authenticationConfig.xsd, as shown in Example 4-5.

Example 4-5 XML element definitions from authenticationConfig.xsd

</choice>

</complexType>

...

</complexType>

<element name="test" type="tns:TestType" minOccurs="0"

maxOccurs="unbounded" />

<element name="testDeviceId" type="tns:TestDeviceIdType" minOccurs="0"

maxOccurs="1" />

<element name="testUser" type="tns:TestUserType" minOccurs="1"

maxOccurs="1" />

</sequence>

</extension>

</complexContent>

</complexType>

The <realms> and <realm> XML elements

Use the parent <realms> and child <realm> XML elements to configure the authentication realms that will be used to authenticate users.

The <realm> element requires a unique name and a loginModule name as arguments to its parameters.

The child <className> element is used to inform the fully qualified Java class name (Java package name plus class name) for the authenticator component that is used by the target authentication realm, as shown in Example 4-6.

Example 4-6 The <realms> and <realm> XML elements

<className>com.worklight.core.auth.ext.HeaderAuthenticator</className>

</realm>

...

</realms>

For a complete reference about how to configure these elements, see the XML excerpt from authenticationConfig.xsd, as shown in Example 4-7.

Example 4-7 XML element definitions from authenticationConfig.xsd

</sequence>

</sequence>

Defines an alias for this realm, used by the client JS library.

</documentation>

</annotation>

</attribute>

</complexType>

The <loginModules> and <loginModule> XML elements

Use the parent <loginModules> and the child <loginModule> XML elements to configure the Java Authorization and Authentication Service (JAAS) login modules that are responsible for verifying the user credentials, and for creating a user identity object that will hold all of the data about the authenticated user or device.

The <loginModule> element requires a unique name. The child <className> element is used to inform the fully qualified Java class name (Java package name plus the class name) for the LoginModule implementation class, as shown in Example 4-8 on page 49.

Example 4-8 The <loginModules> and <loginModule> XML elements

<className>com.worklight.core.auth.ext.HeaderLoginModule</className>

</loginModule>

...

</loginModules>

For a complete reference about how to configure them, see the XML excerpt from authenticationConfig.xsd, as shown in Example 4-9.

Example 4-9 XML element definitions from authenticationConfig.xsd

<element name="loginModule" type="tns:LoginModuleType"

maxOccurs="unbounded" />

</sequence>

</complexType>

...

<element name="parameter" type="tns:ParameterType" minOccurs="0"

maxOccurs="unbounded" />

</sequence>

</complexType>

In document Índice de gráficos (página 43-47)