<!DOCTYPE REFENTRY PUBLIC "-//Sun Microsystems//DTD DocBook V3.0-Based SolBook Subset V2.0//EN" [
<!--ArborText, Inc., 1988-1999, v.4002-->
<!ENTITY metainfo SYSTEM "metainfo.sgm">
<!ENTITY options-common SYSTEM "options-common.sgm">
<!ENTITY synopsis-common SYSTEM "synopsis-common.sgm">
<!ENTITY % commonents SYSTEM "smancommon.ent">
%commonents;
<!ENTITY % booktitles SYSTEM "booktitles.ent">
%booktitles;
<!ENTITY Dash "&ndash;">
]>
<?Pub UDT _bookmark _target>
<?Pub EntList brvbar bull cross dash diam diams frac12 frac13 frac14 hellip
 laquo lArr loz mdash nabla ndash para pound rArr raquo sect yen ne>
<?Pub Inc>
<refentry id="create-message-security-provider-1">
<refmeta><refentrytitle>create-message-security-provider</refentrytitle><manvolnum>
1</manvolnum>&metainfo;
</refmeta>
<refnamediv><indexterm><primary sortas="create-message-security-provider ">
create-message-security-provider  &mdash; Enables administrators to create
the <property>message-security-config</property> and <property>provider-config
</property> sub-elements for the security service in <filename>domain.xml
</filename>.</primary></indexterm><indexterm><primary sortas="Enables administrators to create the <property>message-security-config</property>
and <property>provider-config</property> sub-elements for the security service
in <filename>domain.xml</filename>.">Enables administrators to create the <property>
message-security-config</property> and <property>provider-config</property>
sub-elements for the security service in <filename>domain.xml</filename>. &mdash;
create-message-security-provider </primary></indexterm><refname>create-message-security-provider 
</refname><refpurpose>enables administrators to create the <property>message-security-config
</property> and <property>provider-config</property> sub-elements for the
security service in <filename>domain.xml</filename></refpurpose></refnamediv>
<refsynopsisdiv><title>&synp-tt;</title>
<cmdsynopsis><command>create-message-security-provider</command>&synopsis-common;
<arg>&Dash;&Dash;target  <replaceable>target</replaceable></arg><arg choice="plain">&Dash;&Dash;classname  <replaceable>
provider_class</replaceable></arg><arg>&Dash;&Dash;layer   <replaceable>message_layer
</replaceable> </arg><arg>&Dash;&Dash;providertype <replaceable>provider_type
</replaceable> </arg><arg>&Dash;&Dash;requestauthsource  <replaceable>request_auth_source 
</replaceable> </arg><arg>&Dash;&Dash;requestauthrecipient  <replaceable>
request_auth_recipient </replaceable></arg><arg>&Dash;&Dash;responsetauthsource  <replaceable>
response_auth_source </replaceable> </arg><arg>&Dash;&Dash;responseauthrecipient  <replaceable>
response_auth_recipient </replaceable></arg><arg>&Dash;&Dash;isdefaultprovider
</arg><arg><option role="nodash">&Dash;&Dash;property (<replaceable>name</replaceable>=<replaceable>
value</replaceable>)[:<replaceable>name</replaceable>=<replaceable>value</replaceable>]* 
</option> </arg><arg choice="plain">provider_name</arg>
</cmdsynopsis></refsynopsisdiv>
<refsect1><title>&desc-tt;</title>
<para>Enables the administrator to create the <property>message-security-config
</property> and <property>provider-config</property> sub-elements for the
security service in <filename>domain.xml</filename> (the file that specifies
parameters and properties of a domain to the Application Server). The options
specified in the list below apply to attributes within the <property>message-security-config
</property> and <property>provider-config</property> sub-elements of the <filename>
domain.xml</filename> file.</para>
<para>If the message-layer (<property>message-security-config</property>)
element does not exist, this command creates it, and then <property>provider-config
</property> is created under it.</para>
<para>This command is supported in remote mode only.</para>
</refsect1>
<refsect1><title>&opts-tt;</title>
<para>If an option has a short option name, then the short option preceeds
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="nodash">&Dash;&Dash;target</option> </term>
<listitem><para>In Enterprise Edition, specifies the target to which you are
deploying. The following values are valid: <itemizedlist>
<listitem><para><literal>server</literal> Deploys the component to the default
server instance <literal>server</literal> and is the default value.</para>
</listitem>
<listitem><para><literal>domain</literal> Deploys the component to the domain.
</para>
</listitem>
<listitem><para><replaceable>cluster_name</replaceable> Deploys the component
to every server instance in the cluster.</para>
</listitem>
<listitem><para><replaceable>instance_name</replaceable> Deploys the component
to a particular sever instance.</para>
</listitem>
</itemizedlist></para>
</listitem></varlistentry>
</variablelist></refsect1>
<refsect1><title>OPTIONAL &attr-tt;</title>
<para>The following optional attribute name/value pairs are available:</para>
<informaltable frame="all" orient="port">
<tgroup cols="2" align="left">
<?PubTbl tgroup dispwid="9.17in">
<colspec colname="col1" colwidth="0.68*"><colspec colname="col2" colwidth="1.32*">
<thead>
<row><entry valign="top"><para> Property</para></entry><entry valign="top"><para>
Definition</para></entry></row>
</thead>
<tbody>
<row><entry colname="col1"><para>classname</para></entry><entry colname="col2"><para>
Defines the Java implementation class of the provider. Client authentication
providers must implement the com.sun.enterprise. <classname>security.jauth.ClientAuthModule
</classname> interface. Server-side providers must implement the<classname>
 com.sun.enterprise.security jauth<?Pub _newline>.ServerAuthModule</classname>
interface. A provider may implement both interfaces, but it must implement
the interface corresponding to its provider type.</para></entry></row>
<row><entry colname="col1"><para>layer</para></entry><entry colname="col2"><para>
The message-layer entity used to define the value of the <property>auth-layer
</property> attribute of <property>message-security-config</property> elements.
The default is <property>SOAP</property>.</para></entry></row>
<row><entry colname="col1"><para>providertype</para></entry><entry colname="col2"><para>
Establishes whether the provider is to be used as client authentication provider,
server authentication provider, or both. Valid options for this property include <property>
client</property>, <property>server</property>, or <property>client-server
</property>. The default value is <property>client-server</property>.</para></entry>
</row>
<row><entry colname="col1"><para>requestauthsource</para></entry><entry colname="col2"><para>
The <property>auth-source</property> 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 <property>
sender</property> or <property>content</property>. When this argument is not
specified, source authentication of the request is not required.</para></entry>
</row>
<row><entry colname="col1"><para>requestauthrecipient</para></entry><entry
colname="col2"><para>The<property> auth-recipient</property> 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 <property>before-content
</property> or <property>after-content</property>. The default value is <property>
after-content</property>.</para></entry></row>
<row><entry colname="col1"><para>responseauthsource</para></entry><entry colname="col2"><para>
The <property>auth-source</property> 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 <property>
sender</property> or <property>content</property>. When this option is not
specified, source authentication of the response is not required. </para></entry>
</row>
<row><entry colname="col1"><para>responseauthrecipient</para></entry><entry
colname="col2"><para>The <property>auth-recipient</property> 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 <property>
before-content</property> or <property>after-content</property>. The default
value is <property>after-content</property>.</para></entry></row>
<row><entry colname="col1"><para>isdefaultprovider</para></entry><entry colname="col2"><para>
The <property>default-provider</property> attribute is used to designate the
provider as the default provider (at the layer) of the type or types identified
by the <property>providertype</property> argument. There is no default associated
with this option. </para></entry></row>
<row><entry colname="col1"><para>property</para></entry><entry colname="col2"><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></entry></row>
</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1><title>&oper-tt;</title>
<variablelist termlength="medium">
<varlistentry><term><replaceable>provider_name </replaceable></term><listitem>
<para>The name of the provider used to reference the <property>provider-config
</property> element.</para>
</listitem></varlistentry>
</variablelist></refsect1>
<refsect1><title>&exam-tt;</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><title>&exit-tt;</title>
<variablelist termlength="medium"><?Pub Caret>
<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><title>&also-tt;</title>
<para><link linkend="delete-message-security-provider-1"><citerefentry><refentrytitle>
delete-message-security-provider</refentrytitle><manvolnum>1</manvolnum></citerefentry></link>, <link
linkend="list-message-security-providers-1"><citerefentry><refentrytitle>
list-message-security-providers</refentrytitle><manvolnum>1</manvolnum></citerefentry></link></para>
</refsect1>
</refentry>
<?Pub *0000010914>
