~ubuntu-branches/ubuntu/saucy/lcmaps-plugins-voms/saucy

« back to all changes in this revision

Viewing changes to doc/lcmaps_voms_localaccount.mod.8

  • Committer: Package Import Robot
  • Author(s): Dennis van Dok
  • Date: 2012-11-06 00:50:24 UTC
  • Revision ID: package-import@ubuntu.com-20121106005024-0513ko4vca18a53l
Tags: upstream-1.5.5
ImportĀ upstreamĀ versionĀ 1.5.5

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
.\" In .TH, FOO should be all caps, SECTION should be 1-8, maybe w/ subsection
 
2
.\" other parms are allowed: see man(7), man(1)
 
3
.\"
 
4
.\" This template provided by Tom Christiansen <tchrist@jhereg.perl.com>.
 
5
.\" 
 
6
.TH LCMAPS_VOMS_LOCALACCOUNT.MOD 8 "March 6, 2012"  "Stichting FOM/Nikhef" "Site Access Control"
 
7
.SH NAME
 
8
lcmaps_voms_localaccount.mod \- LCMAPS plugin to switch user identity based on VOMS credentials by local accounts
 
9
.SH SYNOPSIS
 
10
.nh
 
11
.ad l
 
12
.B lcmaps_voms_localaccount.mod
 
13
.RB [ -gridmapfile
 
14
.IR gridmapfile ]
 
15
.RB [ --add-primary-gid-from-mapped-account ]
 
16
.RB [ --do-not-add-primary-gid-from-mapped-account ]
 
17
.RB [ --add-primary-gid-as-secondary-gid-from-mapped-account ]
 
18
.RB [ --add-secondary-gids-from-mapped-account ]
 
19
.RB [ -use_voms_gid | -use-voms-gid ]
 
20
.hy
 
21
.ad b
 
22
.SH DESCRIPTION
 
23
This VOMS localaccount acquisition plugin is a 'VOMS-aware' modification of the
 
24
\fBlcmaps_localaccount.mod.8\fR plugin.  The plugin tries to find a local
 
25
account (more specifically a UserID) based on the VOMS information that has
 
26
available from the LCMAPS, in particular the Fully Qualified Attribute Names
 
27
(FQAN).
 
28
 
 
29
The VOMS credentials need to be available from the LCMAPS framework.
 
30
.SH  OPTIONS
 
31
.TP
 
32
.BI "-gridmapfile " gridmapfile
 
33
This file must contain FQANs to (local) user account names.
 
34
If this option is set, it will override the default path of the
 
35
gridmapfile.  It is advised to use an absolute path to the gridmapfile
 
36
to avoid usage of the wrong file(path).
 
37
 
 
38
.TP
 
39
.BI "--add-primary-gid-from-mapped-account"
 
40
After the account is mapped, add the primary Group ID from the passwd-file/LDAP of the mapped account as a part of the mapping result. Default is to not add the primary Group ID.
 
41
 
 
42
.TP
 
43
.BI "--do-not-add-primary-gid-from-mapped-account"
 
44
After the account is mapped, explicity avoid adding the primary Group ID from the passwd-file/LDAP of the mapped account as a part of the mapping result.. Default is to not add the primary Group ID.
 
45
 
 
46
.TP
 
47
.BI "--add-primary-gid-as-secondary-gid-from-mapped-account"
 
48
After the account is mapped, add the primary Group ID from the passwd-file/LDAP of the mapped account as a secondary Group ID as a part of the mapping result.
 
49
 
 
50
.TP
 
51
.BI "--add-secondary-gids-from-mapped-account"
 
52
After the account is mapped, add the secondary Group ID from the groups-file/LDAP of the mapped account as a secondary Group ID(s) as a part of the mapping result.
 
53
 
 
54
.TP
 
55
.BI "-use_voms_gid" | "-use-voms-gid"
 
56
Warning: Default enabled!
 
57
Switching this \fBon\fR will \fBdisable\fR the automatic inclusion of the primary Group ID and secondary Group ID(s) of the mapped account as a part of the mapping result.
 
58
We advise to switch this option \fBon\fR by default.
 
59
 
 
60
 
 
61
.SH "RETURN VALUES"
 
62
.TP
 
63
.B LCMAPS_MOD_SUCCESS
 
64
Success.
 
65
.TP
 
66
.B LCMAPS_MOD_FAIL
 
67
Failure.
 
68
.SH BUGS
 
69
Please report any errors to the Nikhef Grid Middleware Security Team
 
70
<grid-mw-security-support@nikhef.nl>.
 
71
.SH "SEE ALSO"
 
72
.BR lcmaps.db (5), 
 
73
.BR lcmaps (3).
 
74
.SH AUTHORS
 
75
LCMAPS and the LCMAPS plug-ins were written by the Grid Middleware Security Team 
 
76
<grid-mw-security@nikhef.nl>.