Module org.snmp4j

Package org.snmp4j.security.dh

Class DHOperations

java.lang.Object

org.snmp4j.security.dh.DHOperations

public class DHOperations
extends Object

Implementation of Diffie Hellman operations for SNMP as defined by RFC 2786.

Since:

2.6.0

Author:

Frank Fock

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DHOperations.DHKeyInfo	The DHSharedKeyInfo provides DH key exchange information that associates a user name with a key (private or shared) and authentication and privacy protocol OIDs necessary to create an USM user during a DH kick-start operation.
static enum	DHOperations.KeyType

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DH_AUTH_PROTOCOL_PROPERTY	Property name for authentication protocol OID of the kickstart user entry.
static final String	DH_KICKSTART_SEC_NAME
static final String	DH_KICKSTART_VIEW_NAME
static final String	DH_PARAMS_PROPERTY	Property name with the DHParameters used for the kickstart.
static final String	DH_PRIV_PROTOCOL_PROPERTY	Property name for privacy protocol OID of the kickstart user entry.
static final String	DH_PRIVATE_KEY_PROPERTY	Property name for private keys of Diffie Hellman key exchange property files.
static final String	DH_PUBLIC_KEY_PROPERTY	Property name for public keys of Diffie Hellman key exchange property files.
static final String	DH_RESET_PROPERTY	Property name to reset an USM user with a kickstart user entry.
static final String	DH_VACM_ROLE_PROPERTY	Property name for VACM role of the kickstart user entry.
static final String	DIFFIE_HELLMAN
static final OID	oidUsmDHKickstartMgrPublic
static final OID	oidUsmDHKickstartMyPublic
static final OID	oidUsmDHKickstartSecurityName
static final String	PBKDF2

Constructor Summary

Constructors

Constructor	Description
DHOperations()

Method Summary

Modifier and Type	Method	Description
static BigInteger	bytesToBigInteger(byte[] bytes)	Convert a byte array to a BigInteger.
static byte[]	computeSharedKey(KeyAgreement keyAgreement, byte[] publicKey, DHParameters dhParameters)
static KeyPair	createKeyPair(OctetString publicKeyOctets, OctetString privateKeyOctets, DHParameters dhParameters)
static byte[]	deriveKey(byte[] sharedKey, int keyLength)	Derive the USM key from the Diffie Hellman key exchange.
static byte[]	deriveKeyPBKDF2(byte[] shareKey, int keyLength, SecurityProtocols.SecurityProtocolType securityProtocolType)
static OctetString	derivePrivateKey(KeyPair keyPair)
static OctetString	derivePublicKey(KeyPair keyPair)
static KeyPair	generatePublicKey(DHParameters dhParameters)
static Map<OctetString,OctetString[]>	getDHKickstartPublicKeys(Session session, PDUFactory pduFactory, Target<?> target, Set<OctetString> managerPublic)	Get the public keys of the agent's kickstart table that match the local public keys provided from a remote agent.
static KeyAgreement	getInitializedKeyAgreement(KeyPair keyPair)
static byte[]	keyToBytes(Key key)	Convert a Key to a byte array.

Methods inherited from class java.lang.Object

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

Field Details

DIFFIE_HELLMAN

public static final String DIFFIE_HELLMAN

See Also:

• Constant Field Values

PBKDF2

public static final String PBKDF2

See Also:

• Constant Field Values

DH_KICKSTART_SEC_NAME

public static final String DH_KICKSTART_SEC_NAME

See Also:

• Constant Field Values

DH_KICKSTART_VIEW_NAME

public static final String DH_KICKSTART_VIEW_NAME

See Also:

• Constant Field Values

oidUsmDHKickstartMyPublic

public static final OID oidUsmDHKickstartMyPublic

oidUsmDHKickstartMgrPublic

public static final OID oidUsmDHKickstartMgrPublic

oidUsmDHKickstartSecurityName

public static final OID oidUsmDHKickstartSecurityName

DH_PRIVATE_KEY_PROPERTY

public static final String DH_PRIVATE_KEY_PROPERTY

Property name for private keys of Diffie Hellman key exchange property files.

See Also:

• Constant Field Values

DH_PUBLIC_KEY_PROPERTY

public static final String DH_PUBLIC_KEY_PROPERTY

Property name for public keys of Diffie Hellman key exchange property files.

See Also:

• Constant Field Values

DH_AUTH_PROTOCOL_PROPERTY

public static final String DH_AUTH_PROTOCOL_PROPERTY

Property name for authentication protocol OID of the kickstart user entry.

See Also:

• Constant Field Values

DH_PRIV_PROTOCOL_PROPERTY

public static final String DH_PRIV_PROTOCOL_PROPERTY

Property name for privacy protocol OID of the kickstart user entry.

See Also:

• Constant Field Values

DH_VACM_ROLE_PROPERTY

public static final String DH_VACM_ROLE_PROPERTY

Property name for VACM role of the kickstart user entry.

See Also:

• Constant Field Values

DH_RESET_PROPERTY

public static final String DH_RESET_PROPERTY

Property name to reset an USM user with a kickstart user entry.

See Also:

• Constant Field Values

DH_PARAMS_PROPERTY

public static final String DH_PARAMS_PROPERTY

Property name with the DHParameters used for the kickstart.

See Also:

• Constant Field Values

Constructor Details

DHOperations

public DHOperations()

Method Details

computeSharedKey

public static byte[] computeSharedKey(KeyAgreement keyAgreement,
 byte[] publicKey,
 DHParameters dhParameters)

bytesToBigInteger

public static BigInteger bytesToBigInteger(byte[] bytes)

Convert a byte array to a BigInteger. Adds a leading zero-byte to ensure a positive BigInteger.

Parameters:

bytes - The byte array to convert.

Returns:

the BigInteger containing the provided bytes as unsigned integer.

keyToBytes

public static byte[] keyToBytes(Key key)

Convert a Key to a byte array. Uses X or Y values of a key depending on key type (private or public). Cut off a leading zero-byte if key length is not divisible by 8.

Parameters:

key - The Key to convert.

Returns:

the byte array representation of the key or null.

createKeyPair

public static KeyPair createKeyPair(OctetString publicKeyOctets,
 OctetString privateKeyOctets,
 DHParameters dhParameters)

derivePublicKey

public static OctetString derivePublicKey(KeyPair keyPair)

derivePrivateKey

public static OctetString derivePrivateKey(KeyPair keyPair)

generatePublicKey

public static KeyPair generatePublicKey(DHParameters dhParameters)
                                 throws NoSuchAlgorithmException,
InvalidAlgorithmParameterException

Throws:

NoSuchAlgorithmException

InvalidAlgorithmParameterException

getInitializedKeyAgreement

public static KeyAgreement getInitializedKeyAgreement(KeyPair keyPair)

deriveKey

public static byte[] deriveKey(byte[] sharedKey,
 int keyLength)

Derive the USM key from the Diffie Hellman key exchange.

Parameters:

sharedKey - the shared key (z).

keyLength - the key length of the resulting key in bytes.

Returns:

the USM key as byte array of length keyLength.

deriveKeyPBKDF2

public static byte[] deriveKeyPBKDF2(byte[] shareKey,
 int keyLength,
 SecurityProtocols.SecurityProtocolType securityProtocolType)

getDHKickstartPublicKeys

public static Map<OctetString,OctetString[]> getDHKickstartPublicKeys(Session session,
 PDUFactory pduFactory,
 Target<?> target,
 Set<OctetString> managerPublic)
                                                               throws IOException

Get the public keys of the agent's kickstart table that match the local public keys provided from a remote agent.

Parameters:

session - the SNMP Session to use.

pduFactory - the PDUFactory to be used to create SNMP PDUs for requesting the data.

target - the SNMP agent target.

managerPublic - a set of public keys of this manager for which public keys of the agent should be retrieved.

Returns:

a map that maps the manager's public keys for which an agent public key has been found, to a two-element array with the first element being the agent public key and the second the associated user/security name.

Throws:

IOException - if the SNMP communication fails.