modules/pam_timestamp/pam_timestamp_check.8

   1 .\"     Title: pam_timestamp_check
   2 .\"    Author: [see the "AUTHOR" section]
   3 .\" Generator: DocBook XSL Stylesheets v1.74.0 <http://docbook.sf.net/>
   4 .\"      Date: 08/17/2012
   5 .\"    Manual: Linux-PAM Manual
   6 .\"    Source: Linux-PAM Manual
   7 .\"  Language: English
   8 .\"
   9 .TH "PAM_TIMESTAMP_CHECK" "8" "08/17/2012" "Linux-PAM Manual" "Linux\-PAM Manual"
  10 .\" -----------------------------------------------------------------
  11 .\" * (re)Define some macros
  12 .\" -----------------------------------------------------------------
  13 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  14 .\" toupper - uppercase a string (locale-aware)
  15 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  16 .de toupper
  17 .tr aAbBcCdDeEfFgGhHiIjJkKlLmMnNoOpPqQrRsStTuUvVwWxXyYzZ
  18 \\$*
  19 .tr aabbccddeeffgghhiijjkkllmmnnooppqqrrssttuuvvwwxxyyzz
  20 ..
  21 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  22 .\" SH-xref - format a cross-reference to an SH section
  23 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  24 .de SH-xref
  25 .ie n \{\
  26 .\}
  27 .toupper \\$*
  28 .el \{\
  29 \\$*
  30 .\}
  31 ..
  32 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  33 .\" SH - level-one heading that works better for non-TTY output
  34 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  35 .de1 SH
  36 .\" put an extra blank line of space above the head in non-TTY output
  37 .if t \{\
  38 .sp 1
  39 .\}
  40 .sp \\n[PD]u
  41 .nr an-level 1
  42 .set-an-margin
  43 .nr an-prevailing-indent \\n[IN]
  44 .fi
  45 .in \\n[an-margin]u
  46 .ti 0
  47 .HTML-TAG ".NH \\n[an-level]"
  48 .it 1 an-trap
  49 .nr an-no-space-flag 1
  50 .nr an-break-flag 1
  51 \." make the size of the head bigger
  52 .ps +3
  53 .ft B
  54 .ne (2v + 1u)
  55 .ie n \{\
  56 .\" if n (TTY output), use uppercase
  57 .toupper \\$*
  58 .\}
  59 .el \{\
  60 .nr an-break-flag 0
  61 .\" if not n (not TTY), use normal case (not uppercase)
  62 \\$1
  63 .in \\n[an-margin]u
  64 .ti 0
  65 .\" if not n (not TTY), put a border/line under subheading
  66 .sp -.6
  67 \l'\n(.lu'
  68 .\}
  69 ..
  70 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  71 .\" SS - level-two heading that works better for non-TTY output
  72 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  73 .de1 SS
  74 .sp \\n[PD]u
  75 .nr an-level 1
  76 .set-an-margin
  77 .nr an-prevailing-indent \\n[IN]
  78 .fi
  79 .in \\n[IN]u
  80 .ti \\n[SN]u
  81 .it 1 an-trap
  82 .nr an-no-space-flag 1
  83 .nr an-break-flag 1
  84 .ps \\n[PS-SS]u
  85 \." make the size of the head bigger
  86 .ps +2
  87 .ft B
  88 .ne (2v + 1u)
  89 .if \\n[.$] \&\\$*
  90 ..
  91 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  92 .\" BB/BE - put background/screen (filled box) around block of text
  93 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  94 .de BB
  95 .if t \{\
  96 .sp -.5
  97 .br
  98 .in +2n
  99 .ll -2n
 100 .gcolor red
 101 .di BX
 102 .\}
 103 ..
 104 .de EB
 105 .if t \{\
 106 .if "\\$2"adjust-for-leading-newline" \{\
 107 .sp -1
 108 .\}
 109 .br
 110 .di
 111 .in
 112 .ll
 113 .gcolor
 114 .nr BW \\n(.lu-\\n(.i
 115 .nr BH \\n(dn+.5v
 116 .ne \\n(BHu+.5v
 117 .ie "\\$2"adjust-for-leading-newline" \{\
 118 \M[\\$1]\h'1n'\v'+.5v'\D'P \\n(BWu 0 0 \\n(BHu -\\n(BWu 0 0 -\\n(BHu'\M[]
 119 .\}
 120 .el \{\
 121 \M[\\$1]\h'1n'\v'-.5v'\D'P \\n(BWu 0 0 \\n(BHu -\\n(BWu 0 0 -\\n(BHu'\M[]
 122 .\}
 123 .in 0
 124 .sp -.5v
 125 .nf
 126 .BX
 127 .in
 128 .sp .5v
 129 .fi
 130 .\}
 131 ..
 132 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 133 .\" BM/EM - put colored marker in margin next to block of text
 134 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 135 .de BM
 136 .if t \{\
 137 .br
 138 .ll -2n
 139 .gcolor red
 140 .di BX
 141 .\}
 142 ..
 143 .de EM
 144 .if t \{\
 145 .br
 146 .di
 147 .ll
 148 .gcolor
 149 .nr BH \\n(dn
 150 .ne \\n(BHu
 151 \M[\\$1]\D'P -.75n 0 0 \\n(BHu -(\\n[.i]u - \\n(INu - .75n) 0 0 -\\n(BHu'\M[]
 152 .in 0
 153 .nf
 154 .BX
 155 .in
 156 .fi
 157 .\}
 158 ..
 159 .\" -----------------------------------------------------------------
 160 .\" * set default formatting
 161 .\" -----------------------------------------------------------------
 162 .\" disable hyphenation
 163 .nh
 164 .\" disable justification (adjust text to left margin only)
 165 .ad l
 166 .\" -----------------------------------------------------------------
 167 .\" * MAIN CONTENT STARTS HERE *
 168 .\" -----------------------------------------------------------------
 169 .SH "Name"
 170 pam_timestamp_check \- Check to see if the default timestamp is valid
 171 .SH "Synopsis"
 172 .fam C
 173 .HP \w'\fBpam_timestamp_check\fR\ 'u
 174 \fBpam_timestamp_check\fR [\-k] [\-d] [\fItarget_user\fR]
 175 .fam
 176 .SH "DESCRIPTION"
 177 .PP
 178 With no arguments
 179 \fBpam_timestamp_check\fR
 180 will check to see if the default timestamp is valid, or optionally remove it\&.
 181 .SH "OPTIONS"
 182 .PP
 183 \fB\-k\fR
 184 .RS 4
 185 Instead of checking the validity of a timestamp, remove it\&. This is analogous to sudo\'s
 186 \fI\-k\fR
 187 option\&.
 188 .RE
 189 .PP
 190 \fB\-d\fR
 191 .RS 4
 192 Instead of returning validity using an exit status, loop indefinitely, polling regularly and printing the status on standard output\&.
 193 .RE
 194 .PP
 195 \fB\fItarget_user\fR\fR
 196 .RS 4
 197 By default
 198 \fBpam_timestamp_check\fR
 199 checks or removes timestamps generated by
 200 \fIpam_timestamp\fR
 201 when the user authenticates as herself\&. When the user authenticates as a different user, the name of the timestamp file changes to accommodate this\&.
 202 \fItarget_user\fR
 203 allows to specify this user name\&.
 204 .RE
 205 .SH "RETURN VALUES"
 206 .PP
 207 0
 208 .RS 4
 209 The timestamp is valid\&.
 210 .RE
 211 .PP
 212 2
 213 .RS 4
 214 The binary is not setuid root\&.
 215 .RE
 216 .PP
 217 3
 218 .RS 4
 219 Invalid invocation\&.
 220 .RE
 221 .PP
 222 4
 223 .RS 4
 224 User is unknown\&.
 225 .RE
 226 .PP
 227 5
 228 .RS 4
 229 Permissions error\&.
 230 .RE
 231 .PP
 232 6
 233 .RS 4
 234 Invalid controlling tty\&.
 235 .RE
 236 .PP
 237 7
 238 .RS 4
 239 Timestamp is not valid\&.
 240 .RE
 241 .SH "NOTES"
 242 .PP
 243 Users can get confused when they are not always asked for passwords when running a given program\&. Some users reflexively begin typing information before noticing that it is not being asked for\&.
 244 .SH "EXAMPLES"
 245 .sp
 246 .if n \{\
 247 .RS 4
 248 .\}
 249 .fam C
 250 .ps -1
 251 .nf
 252 .if t \{\
 253 .sp -1
 254 .\}
 255 .BB lightgray adjust-for-leading-newline
 256 .sp -1
 257
 258 auth sufficient pam_timestamp\&.so verbose
 259 auth required   pam_unix\&.so
 260
 261 session required pam_unix\&.so
 262 session optional pam_timestamp\&.so
 263
 264 .EB lightgray adjust-for-leading-newline
 265 .if t \{\
 266 .sp 1
 267 .\}
 268 .fi
 269 .fam
 270 .ps +1
 271 .if n \{\
 272 .RE
 273 .\}
 274 .SH "FILES"
 275 .PP
 276 \FC/var/run/sudo/\&.\&.\&.\F[]
 277 .RS 4
 278 timestamp files and directories
 279 .RE
 280 .SH "SEE ALSO"
 281 .PP
 282
 283 \fBpam_timestamp_check\fR(8),
 284 \fBpam.conf\fR(5),
 285 \fBpam.d\fR(5),
 286 \fBpam\fR(8)
 287 .SH "AUTHOR"
 288 .PP
 289 pam_tally was written by Nalin Dahyabhai\&.