fix-fs-error-string-printing-20010623
[openafs.git] / doc / html / AdminReference / auarf115.htm
1 <!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 4//EN">
2 <HTML><HEAD>
3 <TITLE>Administration Reference</TITLE>
4 <!-- Begin Header Records  ========================================== -->
5 <!-- /tmp/idwt3672/auarf000.scr converted by idb2h R4.2 (359) ID      -->
6 <!-- Workbench Version (AIX) on 3 Oct 2000 at 16:18:30                -->
7 <META HTTP-EQUIV="updated" CONTENT="Tue, 03 Oct 2000 16:18:29">
8 <META HTTP-EQUIV="review" CONTENT="Wed, 03 Oct 2001 16:18:29">
9 <META HTTP-EQUIV="expires" CONTENT="Thu, 03 Oct 2002 16:18:29">
10 </HEAD><BODY>
11 <!-- (C) IBM Corporation 2000. All Rights Reserved    --> 
12 <BODY bgcolor="ffffff"> 
13 <!-- End Header Records  ============================================ -->
14 <A NAME="Top_Of_Page"></A>
15 <H1>Administration Reference</H1>
16 <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> 
17 <P>
18 <H2><A NAME="HDRBOS_SETAUTH" HREF="auarf002.htm#ToC_129">bos setauth</A></H2>
19 <A NAME="IDX4617"></A>
20 <A NAME="IDX4618"></A>
21 <A NAME="IDX4619"></A>
22 <A NAME="IDX4620"></A>
23 <A NAME="IDX4621"></A>
24 <P><STRONG>Purpose</STRONG>
25 <P>Sets authorization checking requirements for all server processes
26 <P><STRONG>Synopsis</STRONG>
27 <PRE><B>bos setauth -server</B> &lt;<VAR>machine&nbsp;name</VAR>>  
28      <B>-authrequired</B> &lt;<VAR>on&nbsp;or&nbsp;off:&nbsp;authentication&nbsp;required&nbsp;for&nbsp;admin&nbsp;requests</VAR>>
29      [<B>-cell</B> &lt;<VAR>cell&nbsp;name</VAR>>]  [<B>-noauth</B>]  [<B>-localauth</B>]  [<B>-help</B>]
30    
31 <B>bos seta -s</B> &lt;<VAR>machine&nbsp;name</VAR>>
32          <B>-a</B> &lt;<VAR>on&nbsp;or&nbsp;off:&nbsp;authentication&nbsp;required&nbsp;for&nbsp;admin&nbsp;requests</VAR>>  
33          [<B>-c</B> &lt;<VAR>cell&nbsp;name</VAR>>]  [<B>-n</B>]  [<B>-l</B>]  [<B>-h</B>]
34 </PRE>
35 <P><STRONG>Description</STRONG>
36 <P>The <B>bos setauth</B> command enables or disables authorization
37 checking on the server machine named by the <B>-server</B>
38 argument. When authorization checking is enabled (the normal case), the
39 AFS server processes running on the machine verify that the issuer of a
40 command meets its privilege requirements. When authorization checking
41 is disabled, server processes perform any action for anyone, including the
42 unprivileged user <B>anonymous</B>; this security exposure precludes
43 disabling of authorization checking except during installation or
44 emergencies.
45 <P>To indicate to the server processes that authorization checking is
46 disabled, the BOS Server creates the zero-length file
47 <B>/usr/afs/local/NoAuth</B> on its local disk. All AFS server
48 processes constantly monitor for the <B>NoAuth</B> file's presence
49 and do not check for authorization when it is present. The BOS Server
50 removes the file when this command is used to reenable authorization
51 checking.
52 <P><STRONG>Cautions</STRONG>
53 <P>Do not create the <B>NoAuth</B> file directly, except when directed by
54 instructions for dealing with emergencies (doing so requires being logged in
55 as the local superuser <B>root</B>). Use this command
56 instead.
57 <P><STRONG>Options</STRONG>
58 <DL>
59 <P><DT><B><B>-server</B>
60 </B><DD>Indicates the server machine on which to enable or disable authorization
61 checking. Identify the machine by IP address or its host name (either
62 fully-qualified or abbreviated unambiguously). For details, see the
63 introductory reference page for the <B>bos</B> command suite.
64 <P><DT><B><B>-authrequired</B>
65 </B><DD>Enables authorization checking if the value is <B>on</B>, or disables
66 it if the value is <B>off</B>.
67 <P><DT><B><B>-cell</B>
68 </B><DD>Names the cell in which to run the command. Do not combine this
69 argument with the <B>-localauth</B> flag. For more details, see the
70 introductory <B>bos</B> reference page.
71 <P><DT><B><B>-noauth</B>
72 </B><DD>Assigns the unprivileged identity <B>anonymous</B> to the
73 issuer. Do not combine this flag with the <B>-localauth</B>
74 flag. For more details, see the introductory <B>bos</B> reference
75 page.
76 <P><DT><B><B>-localauth</B>
77 </B><DD>Constructs a server ticket using a key from the local
78 <B>/usr/afs/etc/KeyFile</B> file. The <B>bos</B> command
79 interpreter presents the ticket to the BOS Server during mutual
80 authentication. Do not combine this flag with the <B>-cell</B> or
81 <B>-noauth</B> options. For more details, see the introductory
82 <B>bos</B> reference page.
83 <P><DT><B>-help
84 </B><DD>Prints the online help for this command. All other valid options
85 are ignored.
86 </DL>
87 <P><STRONG>Examples</STRONG>
88 <P>The following example disables authorization checking on the machine
89 <B>fs7.abc.com</B>:
90 <PRE>   % <B>bos setauth -server fs7.abc.com -authrequired off</B>
91     
92 </PRE>
93 <P><STRONG>Privilege Required</STRONG>
94 <P>The issuer must be listed in the <B>/usr/afs/etc/UserList</B> file on
95 the machine named by the <B>-server</B> argument, or must be logged onto a
96 server machine as the local superuser <B>root</B> if the
97 <B>-localauth</B> flag is included.
98 <P><STRONG>Related Information</STRONG>
99 <P><A HREF="auarf023.htm#HDRKEYFILE">KeyFile</A>
100 <P><A HREF="auarf028.htm#HDRNOAUTH">NoAuth</A>
101 <P><A HREF="auarf035.htm#HDRUSERLIST">UserList</A>
102 <P><A HREF="auarf093.htm#HDRBOS_INTRO">bos</A>
103 <P><A HREF="auarf113.htm#HDRBOS_RESTART">bos restart</A>
104 <P>
105 <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> 
106 <!-- Begin Footer Records  ========================================== -->
107 <P><HR><B> 
108 <br>&#169; <A HREF="http://www.ibm.com/">IBM Corporation 2000.</A>  All Rights Reserved 
109 </B> 
110 <!-- End Footer Records  ============================================ -->
111 <A NAME="Bot_Of_Page"></A>
112 </BODY></HTML>