<!doctype refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [

<!-- Process this file with docbook-to-man to generate an nroff manual
     page: `docbook-to-man manpage.sgml > manpage.1'.  You may view
     the manual page with: `docbook-to-man manpage.sgml | nroff -man |
     less'. The docbook-to-man binary is found in the docbook-to-man
	 package. -->

	<!ENTITY dhfirstname	"<firstname>Fabian</firstname>">
	<!ENTITY dhsurname		"<surname>Fagerholm</surname>">

	<!-- Please adjust the date whenever revising the manpage. -->
	<!ENTITY dhdate		"<date>Jul 10, 2007</date>">

	<!ENTITY dhsection		"<manvolnum>8</manvolnum>">
	<!ENTITY dhemail		"<email>fabbe@debian.org</email>">
	<!ENTITY dhusername	"Fabian Fagerholm">
	<!ENTITY dhucpackage	"<refentrytitle>SASL-SAMPLE-CLIENT</refentrytitle>">
	<!ENTITY dhpackage		"sasl-sample-client">
	<!ENTITY debian		"<productname>Debian</productname>">
	<!ENTITY gnu			"<acronym>GNU</acronym>">

]>

<refentry>
	<refentryinfo>
		<address>&dhemail;</address>
		<author>&dhfirstname; &dhsurname;</author>
		<copyright>
			<year>2007</year>
			<holder>&dhusername;</holder>
		</copyright>
		&dhdate;
	</refentryinfo>
	<refmeta>
		&dhucpackage;

		&dhsection;
	</refmeta>
	<refnamediv>
		<refname>&dhpackage;</refname>
		<refpurpose>Sample client program for demonstrating and testing SASL authentication.</refpurpose>
	</refnamediv>
	<refsynopsisdiv>
		<cmdsynopsis>
			<command>&dhpackage;</command>
			<arg>-b min=<replaceable>N</replaceable>,max=<replaceable>N</replaceable></arg>
			<arg>-e ssf=<replaceable>N</replaceable>,id=<replaceable>ID</replaceable></arg>
			<arg>-m <replaceable>MECH</replaceable></arg>
			<arg>-f <replaceable>FLAGS</replaceable></arg>
			<arg>-i local=<replaceable>IP</replaceable>,remote=<replaceable>IP</replaceable></arg>
			<arg>-p <replaceable>PATH</replaceable></arg>
			<arg>-s <replaceable>NAME</replaceable></arg>
			<arg>-n <replaceable>FQDN</replaceable></arg>
			<arg>-u <replaceable>ID</replaceable></arg>
			<arg>-a <replaceable>ID</replaceable></arg>
		</cmdsynopsis>
	</refsynopsisdiv>
	<refsect1>
		<title>DESCRIPTION</title>

		<para>This manual page documents briefly the
		  <command>&dhpackage;</command> command.</para>

		<para>This manual page was written for the &debian; distribution
		  because the original program does not have a manual page.</para>

		<para><command>&dhpackage;</command> is a program to demonstrate
		  and test SASL authentication. It implements the client part, and
		  the server part is available as sasl-sample-server.</para>
	</refsect1>
	<refsect1>
		<title>OPTIONS</title>

		<para>A summary of options is included below.</para>

		<variablelist>

			<varlistentry>
				<term><option>-b</option></term>
				<listitem>
					<para>Number of bits to use for encryption.</para>
					<variablelist>
						<varlistentry>
							<term>min=N</term>
							<listitem>
								<para>minimum number of bits to use (1 => integrity)</para>
							</listitem>
						</varlistentry>
						<varlistentry>
							<term>max=N</term>
							<listitem>
								<para>maximum number of bits to use</para>
							</listitem>
						</varlistentry>
					</variablelist>
				</listitem>
			</varlistentry>


			<varlistentry>
				<term><option>-e</option></term>
				<listitem>
					<para>Assume external encryption.</para>
					<variablelist>
						<varlistentry>
							<term>ssf=N</term>
							<listitem>
								<para>external mech provides N bits of encryption</para>
							</listitem>
						</varlistentry>
						<varlistentry>
							<term>id=ID</term>
							<listitem>
								<para>external mech provides authentication id ID</para>
							</listitem>
						</varlistentry>
					</variablelist>
				</listitem>
			</varlistentry>

			<varlistentry>
				<term><option>-m</option></term>
				<listitem>
					<para>Force use of MECH for security.</para>
				</listitem>
			</varlistentry>
			
			<varlistentry>
				<term><option>-f</option></term>
				<listitem>
					<para>Set security flags.</para>
					<variablelist>
						<varlistentry>
							<term>noplain</term>
							<listitem>
								<para>require security vs. passive attacks</para>
							</listitem>
						</varlistentry>
						<varlistentry>
							<term>noactive</term>
							<listitem>
								<para>require security vs. active attacks</para>
							</listitem>
						</varlistentry>
						<varlistentry>
							<term>nodict</term>
							<listitem>
								<para>require security vs. passive dictionary attacks</para>
							</listitem>
						</varlistentry>
						<varlistentry>
							<term>forwardsec</term>
							<listitem>
								<para>require forward secrecy</para>
							</listitem>
						</varlistentry>
						<varlistentry>
							<term>maximum</term>
							<listitem>
								<para>require all security flags</para>
							</listitem>
						</varlistentry>
						<varlistentry>
							<term>passcred</term>
							<listitem>
								<para>attempt to pass client credentials</para>
							</listitem>
						</varlistentry>
					</variablelist>
				</listitem>
			</varlistentry>

			<varlistentry>
				<term><option>-i</option></term>
				<listitem>
					<para>Set IP addresses (required by some mechs).</para>
					<variablelist>
						<varlistentry>
							<term>local=IP;PORT</term>
							<listitem>
								<para>set local address to IP, port PORT</para>
							</listitem>
						</varlistentry>
						<varlistentry>
							<term>remote=IP;PORT</term>
							<listitem>
								<para>set remote address to IP, port PORT</para>
							</listitem>
						</varlistentry>
					</variablelist>
				</listitem>
			</varlistentry>

			<varlistentry>
				<term><option>-p</option></term>
				<listitem>
					<para>Colon-separated search path for mechanisms.</para>
				</listitem>
			</varlistentry>

			<varlistentry>
				<term><option>-r</option></term>
				<listitem>
					<para>Realm to use.</para>
				</listitem>
			</varlistentry>

			<varlistentry>
				<term><option>-s</option></term>
				<listitem>
					<para>Service name passed to mechanisms.</para>
				</listitem>
			</varlistentry>

			<varlistentry>
				<term><option>-n</option></term>
				<listitem>
					<para>Server fully-qualified domain name.</para>
				</listitem>
			</varlistentry>

			<varlistentry>
				<term><option>-u</option></term>
				<listitem>
					<para>User (authorization) id to request.</para>
				</listitem>
			</varlistentry>

			<varlistentry>
				<term><option>-a</option></term>
				<listitem>
					<para>Id to authenticate as.</para>
				</listitem>
			</varlistentry>

			<varlistentry>
				<term><option>-d</option></term>
				<listitem>
					<para>Disable client-send-first.</para>
				</listitem>
			</varlistentry>

			<varlistentry>
				<term><option>-l</option></term>
				<listitem>
					<para>Enable server-send-last.</para>
				</listitem>
			</varlistentry>

		</variablelist>
	</refsect1>
	<refsect1>
		<title>AUTHOR</title>

		<para>This manual page was written by &dhusername; &dhemail; for
		  the &debian; system (but may be used by others). Permission is
		  granted to redistribute it and/or modify it under the terms of
		  the &gnu; General Public License as published by the Free
		  Software Foundation; either version 2 of the License, or (at
		  your option) any later version.</para>
	
	</refsect1>
</refentry>
