com.outbackinc.services.protocol.snmp.USM
Class USMUtilities

java.lang.Object
  |
  +--com.outbackinc.services.protocol.snmp.USM.USMUtilities

public class USMUtilities

extends java.lang.Object

This class provides utility methods for use with the User-based Security Model (USM).

See Also:

RFC 2574 - User-based Security Model (USM) for version 3 of the Simple Network Management Protocol (SNMPv3)

Method Summary

static byte[]	generateAuthKeyChangeValue(SnmpAuthoritativeSession cSnmpRemoteAuthoritativeSession, byte[] bNewAuthenticationPassword) Generates the KeyChange value needed to change an authentication key remotely.
static byte[]	generateAuthKeyChangeValue(SnmpAuthoritativeSession cSnmpRemoteAuthoritativeSession, java.lang.String szNewAuthenticationPassword) Deprecated. as of jSNMP v3.1.1 by generateAuthKeyChangeValue(SnmpAuthoritativeSession cSnmpRemoteAuthoritativeSession, byte[] bNewAuthenticationPassword)
static byte[]	generatePrivKeyChangeValue(SnmpAuthoritativeSession cSnmpRemoteAuthoritativeSession, byte[] bNewPrivacyPassword) Generates the KeyChange value needed to change a privacy key remotely.
static byte[]	generatePrivKeyChangeValue(SnmpAuthoritativeSession cSnmpRemoteAuthoritativeSession, java.lang.String szNewPrivacyPassword) Deprecated. as of jSNMP v3.1.1 by generatePrivKeyChangeValue(SnmpAuthoritativeSession cSnmpRemoteAuthoritativeSession, byte[] bNewPrivacyPassword)

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

generatePrivKeyChangeValue

public static byte[] generatePrivKeyChangeValue(SnmpAuthoritativeSession cSnmpRemoteAuthoritativeSession,
                                                byte[] bNewPrivacyPassword)
                                         throws java.lang.IllegalArgumentException

Generates the KeyChange value needed to change a privacy key remotely. The value returned by this method should be used as the varBind value in the SET request for the usmUserOwnPrivKeyChange object. Note that this method does NOT update the authoritative session. To use the new password a new session must be created with the new password once the SET succeeds. This is the preferred method when using VMs with non-ASCII encodings.

Parameters:

cSnmpRemoteAuthoritativeSession - remote authoritative session

bNewPrivacyPassword - new password

Returns:

KeyChange value on success else null

Throws:

java.lang.IllegalArgumentException - if cSnmpRemoteAuthoritativeSession is not a 'remote' or USM authoritative session

generatePrivKeyChangeValue

public static byte[] generatePrivKeyChangeValue(SnmpAuthoritativeSession cSnmpRemoteAuthoritativeSession,
                                                java.lang.String szNewPrivacyPassword)
                                         throws java.lang.IllegalArgumentException

Deprecated. as of jSNMP v3.1.1 by generatePrivKeyChangeValue(SnmpAuthoritativeSession cSnmpRemoteAuthoritativeSession, byte[] bNewPrivacyPassword)

Generates the KeyChange value needed to change a privacy key remotely. The value returned by this method should be used as the varBind value in the SET request for the usmUserOwnPrivKeyChange object. Note that this method does NOT update the authoritative session. To use the new password a new session must be created with the new password once the SET succeeds.

Parameters:

cSnmpRemoteAuthoritativeSession - remote authoritative session

szNewPrivacyPassword - new password

Returns:

KeyChange value on success else null

Throws:

java.lang.IllegalArgumentException - if cSnmpRemoteAuthoritativeSession is not a 'remote' or USM authoritative session

generateAuthKeyChangeValue

public static byte[] generateAuthKeyChangeValue(SnmpAuthoritativeSession cSnmpRemoteAuthoritativeSession,
                                                byte[] bNewAuthenticationPassword)
                                         throws java.lang.IllegalArgumentException

Generates the KeyChange value needed to change an authentication key remotely. The value returned by this method should be used as the varBind value in the SET request for the usmUserOwnAuthKeyChange object. Note that this method does NOT update the authoritative session. To use the new password a new session must be created with the new password once the SET succeeds. This is the preferred method when using VMs with non-ASCII encodings.

Parameters:

cSnmpRemoteAuthoritativeSession - remote authoritative session

bNewAuthenticationPassword - new password

Returns:

KeyChange value on success else null

Throws:

java.lang.IllegalArgumentException - if cSnmpRemoteAuthoritativeSession is not a 'remote' or USM authoritative session

generateAuthKeyChangeValue

public static byte[] generateAuthKeyChangeValue(SnmpAuthoritativeSession cSnmpRemoteAuthoritativeSession,
                                                java.lang.String szNewAuthenticationPassword)
                                         throws java.lang.IllegalArgumentException

Deprecated. as of jSNMP v3.1.1 by generateAuthKeyChangeValue(SnmpAuthoritativeSession cSnmpRemoteAuthoritativeSession, byte[] bNewAuthenticationPassword)

Generates the KeyChange value needed to change an authentication key remotely. The value returned by this method should be used as the varBind value in the SET request for the usmUserOwnAuthKeyChange object. Note that this method does NOT update the authoritative session. To use the new password a new session must be created with the new password once the SET succeeds.

Parameters:

cSnmpRemoteAuthoritativeSession - remote authoritative session

szNewAuthenticationPassword - new password

Returns:

KeyChange value on success else null

Throws:

java.lang.IllegalArgumentException - if cSnmpRemoteAuthoritativeSession is not a 'remote' or USM authoritative session