AFS::ACL - Class to handle the AFS Access Control Lists
use AFS::ACL;
my $acl = AFS::ACL->new({'foobar' => 'none'}, {'anyuser' => 'write'});
$acl->set('rjs' => 'write');
$acl->nset('opusl' => 'write');
$acl->remove('rjsnfs' => 'write');
$acl->clear;
foreach my $user ($acl->get_users) {
print " $user ", $acl->get_rights($user), "\n";
}
foreach my $user ($acl->nget_users) {
print " $user ", $acl->nget_rights($user), "\n";
}
my $ok = $acl->apply('/afs/mpa/home/guest');
my $copy = $acl->copy;
my $rights = AFS::ACL->crights('read');
my $new_acl = AFS::ACL->retrieve('/afs/mpa/home/nog');
$ok = $new_acl->modifyacl('/afs/mpa/home/guest');
NOTE: The following lines are 'version 1' style: all names are exported by default. This style is deprecated !!!
use AFS; # import all AFS names use AFS @AFS::ACL; # import just the ACL names
This class provides methods to handle the AFS Access Control Lists (ACL). It is used to create, modify, delete, and reset ACL instances. It has methods to retrieve and to set the ACL list for directories and its files.
These methods have the optional argument FOLLOW. FOLLOW determines which file should be used should PATH be a symbolic link. If FOLLOW be set to 1, then the symbolic link is followed to its target. If FOLLOW is set to 0, then the method applies to the symbolic link itself. If not specified FOLLOW defaults to 1.
In version 2, some of the methods have been renamed. All old names and interfaces from version 1 are still available for compatibility, but are deprecated. These cases have been marked in the documentation.
You must not intermix names or interfaces from version 1 with names or interfaces from version 2. You either stick with version 1 or version 2.
Version 1 Version 2
-----------------------------------------------------
AFS::ACL::new AFS::ACL->new, new AFS::ACL
newacl AFS::ACL->new, new AFS::ACL
getacl AFS::ACL->retrieve
copyacl AFS::ACL->copyacl
cleanacl AFS::ACL->cleanacl
crights AFS::ACL->crights
ascii2rights AFS::ACL->ascii2rights
rights2ascii AFS::ACL->rights2ascii
$acl->del $acl->remove
$acl->ndel $acl->nremove
$acl->get $acl->get_rights
$acl->nget $acl->nget_rights
$acl->keys $acl->get_users
$acl->nkeys $acl->nget_users
$acl->addacl $acl->add
setacl $acl->apply
modifyacl $acl->modifyacl
Creates a new object of the class AFS::ACL. The constructor takes two optional arguments. %POS and %NEG are lists of positive and negative ACL entries given in the form of user-rights pairs, just like a hash table.
NOTE: these forms are deprecated !!!
$acl = AFS::ACL::new([\%pos [, \%neg]]); $acl = newacl([\%pos [, \%neg]]);
Returns a copy of an existing ACL object.
Retrieves the ACL list for the given PATH and stores it in the object $acl.
NOTE: this form is deprecated !!!
$acl = getacl($path [,$follow=1]);
Copies the ACL list from a source directory FROMDIR to the specified destination directory TODIR. The source directory''s ACL is unchanged.
NOTE: this form is deprecated !!!
$ok = copyacl($from_path, $to_path [,$follow=1]);
Removes from the ACL list of the specified PATH any entry that refers to a user or group that no longer has a Protection Database entry.
NOTE: this form is deprecated !!!
$ok = cleanacl($path [,$follow=1]);
Canonicalizes the RIGHTS string. Duplicate rights will be removed. It recognizes the following special strings: read => rl write => rlidwk all => rlidwka mail => lik
NOTE: this form is deprecated !!!
$crights = crights($rights);
Converts RIGHTS as expressed in a character string to its internal value (an integer with the appropriate bits set). Returns -1 if RIGHTS are not valid (rlidwka, read, write, all, none) or returns the internal value (int32 with bits set).
NOTE: this form is deprecated !!!
$flags = ascii2rights($rights);
Converts the internal value FLAGS to its corresponding character string.
NOTE: this form is deprecated !!!
$print = rights2ascii($flags);
Returns the access rights for the given USER in the positive(->get_rights) or negative(->nget_rights) ACL list.
NOTE: these forms are deprecated !!!
$acl->get($key) $acl->nget($key)
Adds the given USER and its access RIGHTS to the positive(->set) or negative(->nset) ACL list.
Removes the given USER and its access rights from the positive(->remove) or negative(->nremove) ACL list.
NOTE: these forms are deprecated !!!
$acl->del($user) $acl->ndel($user)
Removes all users and their access rights from the positive and negative ACL list.
Removes all users and their access rights from the positive(->clear) or negative(->nclear) ACL list.
Returns users from the positive(->get_users) or negative(->nget_users) ACL list.
NOTE: these forms are deprecated !!!
$acl->keys $acl->nkeys
Returns the number of users in the positive(->length) or negative(->nlength) ACL list.
Returns 1 if the given USER exists in the positive(->exists) or negative(->nexists) ACL list.
Adds all entries of the ACL list NEWACL to the ACL list $acl.
NOTE: this form is deprecated !!!
$acl->addacl(NEWACL)
Sets the ACL list for the given PATH. This call replaces the existing ACL list with the new ACL list $acl.
NOTE: this form is deprecated !!!
$ok = setacl($path, $acl [,$follow=1]);
Sets the ACL to the union of the given $acl list and the current ACL of the PATH. An access right of none or an empty string will cause an entry to be removed from the ACL.
NOTE: this form is deprecated !!!
$ok = modifyacl($path, $acl [,$follow=1])
Norbert E. Gruener <nog@MPA-Garching.MPG.de>.
Roland Schemers <schemers@slapshot.stanford.edu>.
© 2001-2005 Norbert E. Gruener <nog@MPA-Garching.MPG.de>. All rights reserved. © 1994 Board of Trustees, Leland Stanford Jr. University. All rights reserved. Most of the explanations in this document are taken from the original AFS documentation. AFS-3 Programmer's Reference: File Server/Cache Manager Interface Edward R. Zayas © 1991 Transarc Corporation. All rights reserved. IBM AFS Administration Reference © IBM Corporation 2000. All rights reserved.
This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.
Copyright (c) 1994 Board of Trustees, Leland Stanford Jr. University
Redistribution and use in source and binary forms are permitted provided that the above copyright notice and this paragraph are duplicated in all such forms and that any documentation, advertising materials, and other materials related to such distribution and use acknowledge that the software was developed by Stanford University. The name of the University may not be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
Revision $Rev: 687 $
