<!--Arbortext, Inc., 1988-2008, v.4002-->
<!DOCTYPE REFENTRY PUBLIC "-//Sun Microsystems//DTD SolBook 3.5//EN" [
<!ENTITY options-common SYSTEM "options-common.sgm">
<!ENTITY synopsis-common SYSTEM "synopsis-common.sgm">
<!ENTITY % commonents SYSTEM "common.ent">
%commonents;
]>
<?Pub UDT _bookmark _target>
<?Pub EntList bull rArr sect>
<?Pub Inc>
<refentry id="create-message-security-provider-1"><?Pub Tag atict:info
tracking="off" ref="2"><?Pub Tag atict:user user="hl34125" fullname=""><?Pub Tag
atict:user user="pmdavies" fullname=""><?Pub Tag atict:user user="ah95648"
fullname=""><refmeta><refentrytitle>create-message-security-provider</refentrytitle>
<manvolnum>1</manvolnum>
<refmiscinfo class="date">13 Jul 2007</refmiscinfo>
<refmiscinfo class="sectdesc">&man1;</refmiscinfo>
<refmiscinfo class="software">&software;</refmiscinfo>
<refmiscinfo class="arch">generic</refmiscinfo>
<refmiscinfo class="copyright">Copyright (c) 2007, Sun Microsystems, Inc.
All Rights Reserved</refmiscinfo>
</refmeta>
<refnamediv><indexterm><primary><command>create-message-security-provider</command> command
</primary></indexterm><indexterm><primary><literal>message-security-config</literal> element
</primary></indexterm><indexterm><primary><literal>provider-config</literal>element
</primary></indexterm><indexterm><primary><filename>domain.xml</filename> file</primary>
</indexterm><indexterm><primary> security service</primary></indexterm>
<refname>create-message-security-provider </refname><refpurpose>enables administrators
to create the <literal>message-security-config</literal> and <literal>provider-config
</literal> sub-elements for the security service in <filename>domain.xml</filename></refpurpose>
</refnamediv>
<refsynopsisdiv><title></title>
<synopsis><command>create-message-security-provider</command> &synopsis-common;
 [<option role="double-dash">target</option>  <replaceable>target</replaceable>] <option
role="double-dash">classname</option>  <replaceable>provider_class</replaceable>
 [<option role="double-dash">layer</option>   <replaceable>message_layer</replaceable> ] [<option
role="double-dash">providertype</option> <replaceable>provider_type</replaceable> ]
 [<option role="double-dash">requestauthsource</option>  <replaceable>request_auth_source 
</replaceable> ]
 [<option role="double-dash">requestauthrecipient</option>  <replaceable>request_auth_recipient 
</replaceable>]
 [<option role="double-dash">responsetauthsource</option>  <replaceable>response_auth_source 
</replaceable> ]
 [<option role="double-dash">responseauthrecipient</option>  <replaceable>response_auth_recipient 
</replaceable>]
 [<option role="double-dash">isdefaultprovider</option>] [<option
role="double-dash">property</option> <replaceable>name</replaceable>=<replaceable>
value</replaceable>[:<replaceable>name</replaceable>=<replaceable>value</replaceable>]*  ]
 <replaceable>provider_name</replaceable></synopsis>
</refsynopsisdiv>
<refsect1 role="description"><title></title>
<para>Enables the administrator to create the <literal>message-security-config</literal> and <literal>
provider-config</literal> sub-elements for the security service in <filename>domain.xml
</filename> (the file that specifies parameters and properties of a domain<?Pub
Caret>). The options specified in the list below apply to attributes within
the <literal>message-security-config</literal> and <literal>provider-config</literal> sub-elements
of the <filename>domain.xml</filename> file.</para>
<para>If the message-layer (<literal>message-security-config</literal>) element
does not exist, this command creates it, and then <literal>provider-config</literal> is
created under it.</para>
<para>This command is supported in remote mode only.</para>
</refsect1>
<refsect1 role="options"><title></title>
<para>If an option has a short option name, then the short option precedes
the long option name. Short options have one dash whereas long options have
two dashes. </para>
<variablelist termlength="medium">&options-common;
<varlistentry><term><option role="double-dash">target</option> </term>
<listitem><para>&oper-se-ee-only;. Specifies the target on which you are creating
the message security provider. The following values are valid: </para>
<itemizedlist>
<listitem><para><literal>server</literal>&hyphen; Specifies the default server
instance as the target.  <literal>server</literal> is the name of the default
server instance and is the default value.</para></listitem>
<listitem><para><literal>domain</literal>&hyphen; Specifies a certain domain
as the target.</para></listitem>
<listitem><para><replaceable>cluster_name</replaceable>&hyphen; Specifies
a certain cluster as the target.</para></listitem>
<listitem><para><replaceable>instance_name</replaceable>&hyphen; Specifies
a certain server instance as the target.</para></listitem>
</itemizedlist>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="other"><title>Optional Attributes</title>
<para>The following optional attribute name/value pairs are available:</para>
<variablelist termlength="wholeline">
<varlistentry><term><property>classname</property></term>
<listitem><para>Defines the Java implementation class of the provider. Client
authentication providers must implement the <classname> com.sun.enterprise.
security.jauth.ClientAuthModule</classname> interface. Server-side providers
must implement the <classname>com.sun.enterprise.security jauth.ServerAuthModule</classname> interface.
A provider may implement both interfaces, but it must implement the interface
corresponding to its provider type.</para>
</listitem>
</varlistentry>
<varlistentry><term><property>layer</property></term>
<listitem><para>The message-layer entity used to define the value of the <literal>
auth-layer</literal> attribute of <literal>message-security-config</literal> elements.
The default is <literal>SOAP</literal>.</para>
</listitem>
</varlistentry>
<varlistentry><term><property>providertype</property></term>
<listitem><para>Establishes whether the provider is to be used as client authentication
provider, server authentication provider, or both. Valid options for this
property include <literal>client</literal>, <literal>server</literal>, or <literal>
client-server</literal>. The default value is <literal>client-server</literal>.</para>
</listitem>
</varlistentry>
<varlistentry><term><property>requestauthsource</property></term>
<listitem><para>The <literal>auth-source</literal> attribute defines a requirement
for message-layer sender authentication (e.g. username password) or content
authentication (e.g. digital signature) to be applied to request messages.
Possible values are <literal>sender</literal> or <literal>content</literal>.
When this argument is not specified, source authentication of the request
is not required.</para>
</listitem>
</varlistentry>
<varlistentry><term><property>requestauthrecipient</property></term>
<listitem><para>The<literal> auth-recipient</literal> attribute defines a
requirement for message-layer authentication of the receiver of a message
to its sender (e.g. by XML encryption). Possible values are <literal>before-content
</literal> or <literal>after-content</literal>. The default value is <literal>after-content
</literal>.</para>
</listitem>
</varlistentry>
<varlistentry><term><property>responseauthsource</property></term>
<listitem><para>The <literal>auth-source</literal> attribute defines a requirement
for message-layer sender authentication (e.g. username password) or content
authentication (e.g. digital signature) to be applied to response messages.
Possible values are <literal>sender</literal> or <literal>content</literal>.
When this option is not specified, source authentication of the response is
not required. </para>
</listitem>
</varlistentry>
<varlistentry><term><property>responseauthrecipient</property></term>
<listitem><para>The <literal>auth-recipient</literal> attribute defines a
requirement for message-layer authentication of the receiver of the response
message to its sender (e.g. by XML encryption). Possible values are <literal>before-content
</literal> or <literal>after-content</literal>. The default value is <literal>after-content
</literal>.</para>
</listitem>
</varlistentry>
<varlistentry><term><property>isdefaultprovider</property></term>
<listitem><para>The <literal>default-provider</literal> attribute is used
to designate the provider as the default provider (at the layer) of the type
or types identified by the <literal>providertype</literal> argument. There
is no default associated with this option. </para>
</listitem>
</varlistentry>
<varlistentry><term><property>property</property></term>
<listitem><para>Use this property to pass provider-specific property values
to the provider when it is initialized. Properties passed in this way might
include key aliases to be used by the provider to get keys from keystores,
signing, canonicalization, encryption algorithms, etc.</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="operands"><title></title>
<variablelist termlength="medium">
<varlistentry><term><replaceable>provider_name</replaceable></term>
<listitem><para>The name of the provider used to reference the <literal>provider-config
</literal> element.</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="examples"><title></title>
<example><title>Using create-message-security-provider</title>
<para>The following example shows how to create a message security provider
for a client.</para>
<screen>asadmin> <userinput>create-message-security-provider --user admin
--passwordfile pwd_file 
--classname com.sun.enterprise.security.jauth.ClientAuthModule
--providertype client mySecurityProvider</userinput>

</screen>
</example>
</refsect1>
<refsect1 role="exit-status"><title></title>
<variablelist termlength="medium">
<varlistentry><term>0</term>
<listitem><para> command executed successfully</para>
</listitem>
</varlistentry>
<varlistentry><term>1</term>
<listitem><para> error in executing the command</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="see-also"><title></title>
<para><olink targetdoc="asrefman" targetptr="delete-message-security-provider-1">
delete-message-security-provider(1)</olink>, <olink targetdoc="asrefman"
targetptr="list-message-security-providers-1">list-message-security-providers(1)</olink></para>
</refsect1>
</refentry>
