public interface PrivacyProtocol extends SecurityProtocol
PrivacyProtocol
interface defines a common
interface for all SNMP privacy protocols.Modifier and Type | Method and Description |
---|---|
byte[] |
decrypt(byte[] cryptedData,
int offset,
int length,
byte[] decryptionKey,
long engineBoots,
long engineTime,
DecryptParams decryptParams)
Decrypts a message using a given decryption key, engine boots count, and
engine ID.
|
byte[] |
encrypt(byte[] unencryptedData,
int offset,
int length,
byte[] encryptionKey,
long engineBoots,
long engineTime,
DecryptParams decryptParams)
Encrypts a message using a given encryption key, engine boots count, and
engine ID.
|
byte[] |
extendShortKey(byte[] shortKey,
OctetString password,
byte[] engineID,
AuthenticationProtocol authProtocol)
Extend a localized key that is too short.
|
int |
getDecryptParamsLength()
Gets the length of the decryption parameters used by this security
protocol.
|
int |
getEncryptedLength(int scopedPDULength)
Gets the length of a scoped PDU when encrypted with this security protocol.
|
OID |
getID()
Gets the OID uniquely identifying the privacy protocol.
|
int |
getMaxKeyLength()
Gets the maximum key size for this privacy protcol.
|
int |
getMinKeyLength()
Gets the minimum key size for this privacy protcol.
|
byte[] encrypt(byte[] unencryptedData, int offset, int length, byte[] encryptionKey, long engineBoots, long engineTime, DecryptParams decryptParams)
unencryptedData
- the unencrypted data. This byte array may contain leading and trailing
bytes that will not be encrypted.offset
- the offset into the unencryptedData
where to start
encryption.length
- the length of the substring starting at offset
to encrypt.encryptionKey
- the key to be used for encryption.engineBoots
- the engine boots counter to use.engineTime
- the engine time to use.decryptParams
- returns the decryption parameters needed to decrypt the data that
has been encrypted by this method.unencryptedData
.byte[] decrypt(byte[] cryptedData, int offset, int length, byte[] decryptionKey, long engineBoots, long engineTime, DecryptParams decryptParams)
cryptedData
- the crypted data. This byte array may contain leading and trailing
bytes that will not be decrypted.offset
- the offset into the cryptedData
where to start
encryption.length
- the length of the substring starting at offset
to decrypt.decryptionKey
- the key to be used for decryption.engineBoots
- the engine boots counter to use.engineTime
- the engine time to use.decryptParams
- contains the decryption parameters.null
if decryption failed.OID getID()
getID
in interface SecurityProtocol
OID
instance.int getEncryptedLength(int scopedPDULength)
scopedPDULength
- the length of the (unencrypted) scoped PDU.int getMinKeyLength()
int getMaxKeyLength()
int getDecryptParamsLength()
byte[] extendShortKey(byte[] shortKey, OctetString password, byte[] engineID, AuthenticationProtocol authProtocol)
shortKey
- the short key that was generated using
AuthenticationProtocol.passwordToKey(org.snmp4j.smi.OctetString, byte[])
function.password
- the password to use for key extension.engineID
- the SNMP engine ID of the authoritative engine.authProtocol
- the authentication protocol that should be used.shortKey
if no extension is needed.Copyright © 2023 SNMP4J.org. All rights reserved.