Package =TWiki::Users::Password

Base class of all password handlers. Default behaviour is no passwords, so anyone can be anyone they like.

The methods of this class should be overridded by subclasses that want to implement other password handling methods.

ClassMethod new ($session) -> $object

Constructs a new password handler of this type, referring to $session for any required TWiki services.

ObjectMethod finish ()

ObjectMethod readOnly () -> boolean

returns true if the password database is not currently modifyable also needs to call $this->{session}->enter_context('passwords_modifyable'); if you want to be able to use the existing TWikiUserMappingContrib ChangePassword topics

ObjectMethod fetchPass ($login) -> $passwordE

Implements TWiki::Password

Returns encrypted password if succeeds. Returns 0 if login is invalid. Returns undef otherwise.

ObjectMethod checkPassword ($login,$passwordU) -> $boolean

Finds if the password is valid for the given user.

Returns 1 on success, undef on failure.

ObjectMethod removeUser ($login) -> $boolean

Delete the users entry.

If $oldPassU is not correct and not 1, will return 0.

If $oldPassU is 1, will force the change irrespective of the existing password, adding the user if necessary.

encrypt( $login, $passwordU, $fresh ) -> $passwordE

Will return an encrypted password. Repeated calls to encrypt with the same login/passU will return the same passE.

However if the passU is changed, and subsequently changed back to the old login/passU pair, then the old passE is no longer valid.

If $fresh is true, then a new password not based on any pre-existing salt will be used. Set this if you are generating a completely new password.

ObjectMethod error () -> $string

Return any error raised by the last method call, or undef if the last method call succeeded.

ObjectMethod *isManagingEmails () -> $boolean

The default ('none') password manager does not manage emails.

ObjectMethod getEmails ($login) -> @emails

ObjectMethod setEmails ($login,@emails) -> $boolean

ObjectMethod *findUserByEmail ($email) -> \@users

Called by Users.pm.

ObjectMethod canFetchUsers () -> boolean

returns true if the fetchUsers method is implemented and can return an iterator of users. returns undef / nothing in this case, as we are unable to generate a list of users

ObjectMethod fetchUsers () -> newTWiki::ListIterator(\@users)

returns a TWikiIterator of loginnames from the password source. If AllowLoginNames is false this is used to remove the need for a TWikiUsers topic.

Package =TWiki::Users::Password

Base class of all password handlers. Default behaviour is no passwords, so anyone can be anyone they like.

The methods of this class should be overridded by subclasses that want to implement other password handling methods.

ClassMethod new ($session) -> $object

Constructs a new password handler of this type, referring to $session for any required TWiki services.

ObjectMethod finish ()

ObjectMethod readOnly () -> boolean

returns true if the password database is not currently modifyable also needs to call $this->{session}->enter_context('passwords_modifyable'); if you want to be able to use the existing TWikiUserMappingContrib ChangePassword topics

ObjectMethod fetchPass ($login) -> $passwordE

Implements TWiki::Password

Returns encrypted password if succeeds. Returns 0 if login is invalid. Returns undef otherwise.

ObjectMethod checkPassword ($login,$passwordU) -> $boolean

Finds if the password is valid for the given user.

Returns 1 on success, undef on failure.

ObjectMethod removeUser ($login) -> $boolean

Delete the users entry.

ObjectMethod setPassword ($login,$newPassU,$oldPassU) -> $boolean

If the $oldPassU matches matches the user's password, then it will replace it with $newPassU.

If $oldPassU is not correct and not 1, will return 0.

If $oldPassU is 1, will force the change irrespective of the existing password, adding the user if necessary.

Otherwise returns 1 on success, undef on failure.

encrypt( $login, $passwordU, $fresh ) -> $passwordE

Will return an encrypted password. Repeated calls to encrypt with the same login/passU will return the same passE.

However if the passU is changed, and subsequently changed back to the old login/passU pair, then the old passE is no longer valid.

If $fresh is true, then a new password not based on any pre-existing salt will be used. Set this if you are generating a completely new password.

ObjectMethod error () -> $string

Return any error raised by the last method call, or undef if the last method call succeeded.

ObjectMethod *isManagingEmails () -> $boolean

The default ('none') password manager does not manage emails.

ObjectMethod getEmails ($login) -> @emails

ObjectMethod setEmails ($login,@emails) -> $boolean

Called by Users.pm.

ObjectMethod canFetchUsers () -> boolean

returns true if the fetchUsers method is implemented and can return an iterator of users. returns undef / nothing in this case, as we are unable to generate a list of users

ObjectMethod fetchUsers () -> newTWiki::ListIterator(\@users)

returns a TWikiIterator of loginnames from the password source. If AllowLoginNames is false this is used to remove the need for a TWikiUsers topic.

Package =TWiki::Users::Password

Base class of all password handlers. Default behaviour is no passwords, so anyone can be anyone they like.

The methods of this class should be overridded by subclasses that want to implement other password handling methods.

ClassMethod new ($session) -> $object

Constructs a new password handler of this type, referring to $session for any required TWiki services.

ObjectMethod fetchPass ($login) -> $passwordE

Implements TWiki::Password

If $oldPassU is not correct and not 1, will return 0.

If $oldPassU is 1, will force the change irrespective of the existing password, adding the user if necessary.

Otherwise returns 1 on success, undef on failure.

ObjectMethod error () -> $string

Return any error raised by the last method call, or undef if the last method call succeeded.

Package =TWiki::Users::Password

Base class of all password handlers. Default behaviour is no passwords, so anyone can be anyone they like.

The methods of this class should be overridded by subclasses that want to implement other password handling methods.

ClassMethod new ($session) -> $object

Constructs a new password handler of this type, referring to $session for any required TWiki services.

ObjectMethod *finish

1. breaking circular references to allow garbage collection in persistent environments

ObjectMethod fetchPass ($login) -> $passwordE

Returns encrypted password if succeeds. Returns 0 if login is invalid. Returns undef otherwise.

ObjectMethod checkPassword ($user,$passwordU) -> $boolean

Finds if the password is valid for the given login.

Returns 1 on success, undef on failure.

ObjectMethod deleteUser ($user) -> $boolean

Delete users entry.

Returns 1 on success, undef on failure.

ObjectMethod passwd ($user,$newPassU,$oldPassU) -> $boolean

If the $oldPassU is undef, it will try to add the user, failing if they are already there.

If the $oldPassU matches matches the login's password, then it will replace it with $newPassU.

If $oldPassU is not correct and not 1, will return 0.

If $oldPassU is 1, will force the change irrespective of the existing password, adding the user if necessary.

Otherwise returns 1 on success, undef on failure.

encrypt( $user, $passwordU, $fresh ) -> $passwordE

Will return an encrypted password. Repeated calls to encrypt with the same user/passU will return the same passE.

However if the passU is changed, and subsequently changed back to the old user/passU pair, then the old passE is no longer valid.

If $fresh is true, then a new password not based on any pre-existing salt will be used. Set this if you are generating a completely new password.

ObjectMethod error () -> $string

Return any error raised by the last method call, or undef if the last method call succeeded.

ObjectMethod getEmails ($user) -> @emails

Fetch the email address(es) for the given username. Default behaviour is to look up the users' personal topic.

ObjectMethod setEmails ($user,@emails)

Set the email address(es) for the given username in the user topic.

Package =TWiki::Users::Password

Base class of all password handlers. Default behaviour is no passwords, so anyone can be anyone they like.

The methods of this class should be overridded by subclasses that want to implement other password handling methods.

ClassMethod new ($session) -> $object

Constructs a new password handler of this type, referring to $session for any required TWiki services.

ObjectMethod fetchPass ($login) -> $passwordE

Returns encrypted password if succeeds. Returns 0 if login is invalid. Returns undef otherwise.

ObjectMethod checkPassword ($user,$passwordU) -> $boolean

Finds if the password is valid for the given login.

Returns 1 on success, undef on failure.

ObjectMethod deleteUser ($user) -> $boolean

Delete users entry.

Returns 1 on success, undef on failure.

ObjectMethod passwd ($user,$newPassU,$oldPassU) -> $boolean

If the $oldPassU is undef, it will try to add the user, failing if they are already there.

If the $oldPassU matches matches the login's password, then it will replace it with $newPassU.

If $oldPassU is not correct and not 1, will return 0.

If $oldPassU is 1, will force the change irrespective of the existing password, adding the user if necessary.

Otherwise returns 1 on success, undef on failure.

encrypt( $user, $passwordU, $fresh ) -> $passwordE

Will return an encrypted password. Repeated calls to encrypt with the same user/passU will return the same passE.

However if the passU is changed, and subsequently changed back to the old user/passU pair, then the old passE is no longer valid.

If $fresh is true, then a new password not based on any pre-existing salt will be used. Set this if you are generating a completely new password.

ObjectMethod error () -> $string

Return any error raised by the last method call, or undef if the last method call succeeded.

ObjectMethod getEmails ($user) -> @emails

Fetch the email address(es) for the given username. Default behaviour is to look up the users' personal topic.

ObjectMethod setEmails ($user,@emails)

Set the email address(es) for the given username in the user topic.

Package =TWiki::Users::Password

Base class of all password handlers. Default behaviour is no passwords, so anyone can be anyone they like.

The methods of this class should be overridded by subclasses that want to implement other password handling methods.

ClassMethod new ($session) -> $object

Constructs a new password handler of this type, referring to $session for any required TWiki services.

ObjectMethod fetchPass ($login) -> $passwordE

Returns encrypted password if succeeds. Returns 0 if login is invalid. Returns undef otherwise.

ObjectMethod checkPassword ($user,$passwordU) -> $boolean

Finds if the password is valid for the given login.

Returns 1 on success, undef on failure.

ObjectMethod deleteUser ($user) -> $boolean

Delete users entry.

Returns 1 on success, undef on failure.

ObjectMethod passwd ($user,$newPassU,$oldPassU) -> $boolean

If the $oldPassU is undef, it will try to add the user, failing if they are already there.

If the $oldPassU matches matches the login's password, then it will replace it with $newPassU.

If $oldPassU is not correct and not 1, will return 0.

If $oldPassU is 1, will force the change irrespective of the existing password, adding the user if necessary.

Otherwise returns 1 on success, undef on failure.

encrypt( $user, $passwordU, $fresh ) -> $passwordE

Will return an encrypted password. Repeated calls to encrypt with the same user/passU will return the same passE.

However if the passU is changed, and subsequently changed back to the old user/passU pair, then the old passE is no longer valid.

If $fresh is true, then a new password not based on any pre-existing salt will be used. Set this if you are generating a completely new password.

ObjectMethod error () -> $string

Return any error raised by the last method call, or undef if the last method call succeeded.

ObjectMethod getEmails ($user) -> @emails

Fetch the email address(es) for the given username. Default behaviour is to look up the users' personal topic.

ObjectMethod setEmails ($user,@emails)

Set the email address(es) for the given username in the user topic.