Skip to content

support for snmpv3 engine ID #67

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

support for snmpv3 engine ID #67

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion lib/logstash/inputs/snmp.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,6 +94,9 @@ class LogStash::Inputs::Snmp < LogStash::Inputs::Base
# The SNMPv3 security level can be Authentication, No Privacy; Authentication, Privacy; or no Authentication, no Privacy
config :security_level, :validate => ["noAuthNoPriv", "authNoPriv", "authPriv"]

# The SNMPv3 optional engine ID
config :engine_id, :validate => :string

BASE_MIB_PATH = ::File.join(__FILE__, "..", "..", "..", "mibs")
PROVIDED_MIB_PATHS = [::File.join(BASE_MIB_PATH, "logstash"), ::File.join(BASE_MIB_PATH, "ietf")].map { |path| ::File.expand_path(path) }

Expand Down Expand Up @@ -152,7 +155,7 @@ def register
validate_v3_user! # don't really care if verified for every host
auth_pass = @auth_pass.nil? ? nil : @auth_pass.value
priv_pass = @priv_pass.nil? ? nil : @priv_pass.value
definition[:client] = LogStash::SnmpClientV3.new(protocol, address, port, retries, timeout, mib, @security_name, @auth_protocol, auth_pass, @priv_protocol, priv_pass, @security_level)
definition[:client] = LogStash::SnmpClientV3.new(protocol, address, port, retries, timeout, mib, @security_name, @auth_protocol, auth_pass, @priv_protocol, priv_pass, @security_level, @engine_id)
else
definition[:client] = LogStash::SnmpClient.new(protocol, address, port, community, version, retries, timeout, mib)
end
Expand Down
5 changes: 3 additions & 2 deletions lib/logstash/inputs/snmp/clientv3.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@
module LogStash
class SnmpClientV3 < BaseSnmpClient

def initialize(protocol, address, port, retries, timeout, mib, security_name, auth_protocol, auth_pass, priv_protocol, priv_pass, security_level)
def initialize(protocol, address, port, retries, timeout, mib, security_name, auth_protocol, auth_pass, priv_protocol, priv_pass, security_level, engine_id)
super(protocol, address, port, retries, timeout, mib)

security_level = parse_security_level(security_level)
Expand All @@ -48,8 +48,9 @@ def initialize(protocol, address, port, retries, timeout, mib, security_name, au
priv_protocol = parse_priv_protocol(priv_protocol)
auth_pass = auth_pass.nil? ? nil : OctetString.new(auth_pass)
priv_pass = priv_pass.nil? ? nil : OctetString.new(priv_pass)
engine_id = OctetString.new(engine_id.nil? ? MPv3.createLocalEngineID : engine_id)

usm = USM.new(SecurityProtocols.getInstance, OctetString.new(MPv3.createLocalEngineID), 0)
usm = USM.new(SecurityProtocols.getInstance, engine_id, 0)
SecurityModels.getInstance.addSecurityModel(usm)

@snmp.getUSM.addUser(UsmUser.new(security_name, auth_protocol, auth_pass, priv_protocol, priv_pass))
Expand Down
3 changes: 2 additions & 1 deletion spec/inputs/snmp_spec.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,8 @@
let(:valid_configs) {
[
{"get" => ["1.0"], "hosts" => [{"host" => "udp:127.0.0.1/161", "version" => "3"}], "security_name" => "ciscov3", "auth_protocol" => "sha", "auth_pass" => "myshapass", "priv_protocol" => "aes", "priv_pass" => "myprivpass", "security_level" => "authNoPriv"},
{"get" => ["1.0"], "hosts" => [{"host" => "udp:127.0.0.1/161", "version" => "3"}], "security_name" => "dellv3", "auth_protocol" => "md5", "auth_pass" => "myshapass", "priv_protocol" => "3des", "priv_pass" => "myprivpass", "security_level" => "authNoPriv"}
{"get" => ["1.0"], "hosts" => [{"host" => "udp:127.0.0.1/161", "version" => "3"}], "security_name" => "dellv3", "auth_protocol" => "md5", "auth_pass" => "myshapass", "priv_protocol" => "3des", "priv_pass" => "myprivpass", "security_level" => "authNoPriv"},
{"get" => ["1.0"], "hosts" => [{"host" => "udp:127.0.0.1/161", "version" => "3"}], "security_name" => "dellv3", "auth_protocol" => "md5", "auth_pass" => "myshapass", "priv_protocol" => "3des", "priv_pass" => "myprivpass", "security_level" => "authNoPriv", "engine_id" => "some engine"}
]
}

Expand Down