initial-html-documentation-20010606
[openafs.git] / doc / html / AdminReference / auarf115.htm
diff --git a/doc/html/AdminReference/auarf115.htm b/doc/html/AdminReference/auarf115.htm
new file mode 100644 (file)
index 0000000..c53af23
--- /dev/null
@@ -0,0 +1,112 @@
+<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 4//EN">
+<HTML><HEAD>
+<TITLE>Administration Reference</TITLE>
+<!-- Begin Header Records  ========================================== -->
+<!-- /tmp/idwt3672/auarf000.scr converted by idb2h R4.2 (359) ID      -->
+<!-- Workbench Version (AIX) on 3 Oct 2000 at 16:18:30                -->
+<META HTTP-EQUIV="updated" CONTENT="Tue, 03 Oct 2000 16:18:29">
+<META HTTP-EQUIV="review" CONTENT="Wed, 03 Oct 2001 16:18:29">
+<META HTTP-EQUIV="expires" CONTENT="Thu, 03 Oct 2002 16:18:29">
+</HEAD><BODY>
+<!-- (C) IBM Corporation 2000. All Rights Reserved    --> 
+<BODY bgcolor="ffffff"> 
+<!-- End Header Records  ============================================ -->
+<A NAME="Top_Of_Page"></A>
+<H1>Administration Reference</H1>
+<HR><P ALIGN="center"> <A HREF="../index.htm"><IMG SRC="../books.gif" BORDER="0" ALT="[Return to Library]"></A> <A HREF="auarf002.htm#ToC"><IMG SRC="../toc.gif" BORDER="0" ALT="[Contents]"></A> <A HREF="auarf114.htm"><IMG SRC="../prev.gif" BORDER="0" ALT="[Previous Topic]"></A> <A HREF="#Bot_Of_Page"><IMG SRC="../bot.gif" BORDER="0" ALT="[Bottom of Topic]"></A> <A HREF="auarf116.htm"><IMG SRC="../next.gif" BORDER="0" ALT="[Next Topic]"></A> <A HREF="auarf284.htm#HDRINDEX"><IMG SRC="../index.gif" BORDER="0" ALT="[Index]"></A> <P> 
+<P>
+<H2><A NAME="HDRBOS_SETAUTH" HREF="auarf002.htm#ToC_129">bos setauth</A></H2>
+<A NAME="IDX4617"></A>
+<A NAME="IDX4618"></A>
+<A NAME="IDX4619"></A>
+<A NAME="IDX4620"></A>
+<A NAME="IDX4621"></A>
+<P><STRONG>Purpose</STRONG>
+<P>Sets authorization checking requirements for all server processes
+<P><STRONG>Synopsis</STRONG>
+<PRE><B>bos setauth -server</B> &lt;<VAR>machine&nbsp;name</VAR>>  
+     <B>-authrequired</B> &lt;<VAR>on&nbsp;or&nbsp;off:&nbsp;authentication&nbsp;required&nbsp;for&nbsp;admin&nbsp;requests</VAR>>
+     [<B>-cell</B> &lt;<VAR>cell&nbsp;name</VAR>>]  [<B>-noauth</B>]  [<B>-localauth</B>]  [<B>-help</B>]
+   
+<B>bos seta -s</B> &lt;<VAR>machine&nbsp;name</VAR>>
+         <B>-a</B> &lt;<VAR>on&nbsp;or&nbsp;off:&nbsp;authentication&nbsp;required&nbsp;for&nbsp;admin&nbsp;requests</VAR>>  
+         [<B>-c</B> &lt;<VAR>cell&nbsp;name</VAR>>]  [<B>-n</B>]  [<B>-l</B>]  [<B>-h</B>]
+</PRE>
+<P><STRONG>Description</STRONG>
+<P>The <B>bos setauth</B> command enables or disables authorization
+checking on the server machine named by the <B>-server</B>
+argument. When authorization checking is enabled (the normal case), the
+AFS server processes running on the machine verify that the issuer of a
+command meets its privilege requirements. When authorization checking
+is disabled, server processes perform any action for anyone, including the
+unprivileged user <B>anonymous</B>; this security exposure precludes
+disabling of authorization checking except during installation or
+emergencies.
+<P>To indicate to the server processes that authorization checking is
+disabled, the BOS Server creates the zero-length file
+<B>/usr/afs/local/NoAuth</B> on its local disk. All AFS server
+processes constantly monitor for the <B>NoAuth</B> file's presence
+and do not check for authorization when it is present. The BOS Server
+removes the file when this command is used to reenable authorization
+checking.
+<P><STRONG>Cautions</STRONG>
+<P>Do not create the <B>NoAuth</B> file directly, except when directed by
+instructions for dealing with emergencies (doing so requires being logged in
+as the local superuser <B>root</B>). Use this command
+instead.
+<P><STRONG>Options</STRONG>
+<DL>
+<P><DT><B><B>-server</B>
+</B><DD>Indicates the server machine on which to enable or disable authorization
+checking. Identify the machine by IP address or its host name (either
+fully-qualified or abbreviated unambiguously). For details, see the
+introductory reference page for the <B>bos</B> command suite.
+<P><DT><B><B>-authrequired</B>
+</B><DD>Enables authorization checking if the value is <B>on</B>, or disables
+it if the value is <B>off</B>.
+<P><DT><B><B>-cell</B>
+</B><DD>Names the cell in which to run the command. Do not combine this
+argument with the <B>-localauth</B> flag. For more details, see the
+introductory <B>bos</B> reference page.
+<P><DT><B><B>-noauth</B>
+</B><DD>Assigns the unprivileged identity <B>anonymous</B> to the
+issuer. Do not combine this flag with the <B>-localauth</B>
+flag. For more details, see the introductory <B>bos</B> reference
+page.
+<P><DT><B><B>-localauth</B>
+</B><DD>Constructs a server ticket using a key from the local
+<B>/usr/afs/etc/KeyFile</B> file. The <B>bos</B> command
+interpreter presents the ticket to the BOS Server during mutual
+authentication. Do not combine this flag with the <B>-cell</B> or
+<B>-noauth</B> options. For more details, see the introductory
+<B>bos</B> reference page.
+<P><DT><B>-help
+</B><DD>Prints the online help for this command. All other valid options
+are ignored.
+</DL>
+<P><STRONG>Examples</STRONG>
+<P>The following example disables authorization checking on the machine
+<B>fs7.abc.com</B>:
+<PRE>   % <B>bos setauth -server fs7.abc.com -authrequired off</B>
+    
+</PRE>
+<P><STRONG>Privilege Required</STRONG>
+<P>The issuer must be listed in the <B>/usr/afs/etc/UserList</B> file on
+the machine named by the <B>-server</B> argument, or must be logged onto a
+server machine as the local superuser <B>root</B> if the
+<B>-localauth</B> flag is included.
+<P><STRONG>Related Information</STRONG>
+<P><A HREF="auarf023.htm#HDRKEYFILE">KeyFile</A>
+<P><A HREF="auarf028.htm#HDRNOAUTH">NoAuth</A>
+<P><A HREF="auarf035.htm#HDRUSERLIST">UserList</A>
+<P><A HREF="auarf093.htm#HDRBOS_INTRO">bos</A>
+<P><A HREF="auarf113.htm#HDRBOS_RESTART">bos restart</A>
+<P>
+<HR><P ALIGN="center"> <A HREF="../index.htm"><IMG SRC="../books.gif" BORDER="0" ALT="[Return to Library]"></A> <A HREF="auarf002.htm#ToC"><IMG SRC="../toc.gif" BORDER="0" ALT="[Contents]"></A> <A HREF="auarf114.htm"><IMG SRC="../prev.gif" BORDER="0" ALT="[Previous Topic]"></A> <A HREF="#Top_Of_Page"><IMG SRC="../top.gif" BORDER="0" ALT="[Top of Topic]"></A> <A HREF="auarf116.htm"><IMG SRC="../next.gif" BORDER="0" ALT="[Next Topic]"></A> <A HREF="auarf284.htm#HDRINDEX"><IMG SRC="../index.gif" BORDER="0" ALT="[Index]"></A> <P> 
+<!-- Begin Footer Records  ========================================== -->
+<P><HR><B> 
+<br>&#169; <A HREF="http://www.ibm.com/">IBM Corporation 2000.</A>  All Rights Reserved 
+</B> 
+<!-- End Footer Records  ============================================ -->
+<A NAME="Bot_Of_Page"></A>
+</BODY></HTML>