diff options
| author | Ilya Etingof <etingof@gmail.com> | 2019-08-03 11:03:19 +0200 |
|---|---|---|
| committer | Ilya Etingof <etingof@gmail.com> | 2019-08-03 11:10:12 +0200 |
| commit | 6d0b76cef167d1f619412104e9ea2b67d2b405a0 (patch) | |
| tree | c89d00740379d292b93b685c2eba9400749d2078 /docs/source | |
| parent | a901d4f4e7e8e54eebce7f79f88c9070e3e94db2 (diff) | |
| download | pysnmp-git-add-usm-local-key-config.tar.gz | |
Add USM master and localized keys configuration supportadd-usm-local-key-config
Added new optional parameters to `addUsmUser()` and
`hlapi.UsmUserData()` functions allowing specifying key material
type being passed to the respective routines.
Plain-text pass-phrase remains the default, while user can change that
to `master` or `localized` types.
Refer to RFC3414 for technical details on SNMP USM key localization
algorithm.
Diffstat (limited to 'docs/source')
| -rw-r--r-- | docs/source/docs/api-reference.rst | 12 |
1 files changed, 9 insertions, 3 deletions
diff --git a/docs/source/docs/api-reference.rst b/docs/source/docs/api-reference.rst index bc6f5693..b32f4dd0 100644 --- a/docs/source/docs/api-reference.rst +++ b/docs/source/docs/api-reference.rst @@ -217,7 +217,7 @@ User-based The :py:class:`~pysnmp.hlapi.UsmUserData` class provides SNMPv3 User-Based Security Model configuration for SNMP v3 systems. -.. autoclass:: pysnmp.hlapi.UsmUserData(userName, authKey=None, privKey=None, authProtocol=usmNoAuthProtocol, privProtocol=usmNoPrivProtocol, securityEngineId=None) +.. autoclass:: pysnmp.hlapi.UsmUserData(userName, authKey=None, privKey=None, authProtocol=usmNoAuthProtocol, privProtocol=usmNoPrivProtocol, securityEngineId=None, authKeyType=usmKeyTypePassphrase, privKeyType=usmKeyTypePassphrase) **Authentication protocol identifiers** @@ -240,10 +240,16 @@ Security Model configuration for SNMP v3 systems. .. autodata:: pysnmp.hlapi.usmAesBlumenthalCfb192Protocol .. autodata:: pysnmp.hlapi.usmAesBlumenthalCfb256Protocol +**Key material types** + +.. autodata:: pysnmp.hlapi.usmKeyTypePassphrase +.. autodata:: pysnmp.hlapi.usmKeyTypeMaster +.. autodata:: pysnmp.hlapi.usmKeyTypeLocalized + .. note:: - SNMP authentication and encryption keys must be at least *eight* - octets long. + SNMP authentication and encryption keys must be at least *8* + and at most *32* octets long. Transport configuration is I/O framework specific and is described in respective sections. |