GetUserPassword Event

Retrieves a password associated with a user.

Object Oriented Interface

public function fireGetUserPassword($param);

Procedural Interface

ipworkssnmp_snmptcpagent_register_callback($res, 11, array($this, 'fireGetUserPassword'));

Parameter List


'passwordtype'
'user'
'password'
'algorithm'

Remarks

The GetUserPassword event is fired after initial inspection of SNMPv3 requests.

The type of password required is provided in the PasswordType parameter: 1 for authentication, and 2 for encryption (privacy).

The password corresponding to User (if any) must be provided in the Password parameter. If the password is valid, processing will continue to other events such as GetRequest, SetRequest, etc.

If the PasswordType parameter is 1 (authentication is used), the Algorithm parameter can be set. Possible values are:

ValueAuthentication Algorithm
0 (default)Any
1MD5
2SHA1
3SHA256
4SHA512

If the PasswordType parameter is 2 (encryption is used), the Algorithm parameter must also be set. Possible values are:

ValueEncryption Algorithm
1 (default)DES
2AES
33DES
4AES192
5AES256

If the password does not match the signature in the request, a BadPacket event will be fired, at which point you can decide whether to report the error to the client (see the description of the BadPacket event for more information).

If the User is invalid or unknown, set the password to empty string (default) to ignore the request. This will result in a BadPacket event being fired, at which point you can decide whether to report the error to the client or not.

Copyright (c) 2021 /n software inc. - All rights reserved.
IPWorks SNMP 2020 PHP Edition - Version 20.0 [Build 7941]