%% %% %CopyrightBegin% %% %% Copyright Ericsson AB 2006-2010. All Rights Reserved. %% %% The contents of this file are subject to the Erlang Public License, %% Version 1.1, (the "License"); you may not use this file except in %% compliance with the License. You should have received a copy of the %% Erlang Public License along with this software. If not, it can be %% retrieved online at http://www.erlang.org/. %% %% Software distributed under the License is distributed on an "AS IS" %% basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See %% the License for the specific language governing rights and limitations %% under the License. %% %% %CopyrightEnd% %% -module(snmpa_conf). %% Avoid warning for local function error/1 clashing with autoimported BIF. -compile({no_auto_import,[error/1]}). -export([ %% agent.conf agent_entry/2, write_agent_config/2, write_agent_config/3, append_agent_config/2, read_agent_config/1, %% context.conf context_entry/1, write_context_config/2, write_context_config/3, append_context_config/2, read_context_config/1, %% community.conf community_entry/1, community_entry/5, write_community_config/2, write_community_config/3, append_community_config/2, read_community_config/1, %% standard.conf standard_entry/2, write_standard_config/2, write_standard_config/3, append_standard_config/2, read_standard_config/1, %% target_addr.conf target_addr_entry/5, target_addr_entry/6, target_addr_entry/8, target_addr_entry/10, target_addr_entry/11, write_target_addr_config/2, write_target_addr_config/3, append_target_addr_config/2, read_target_addr_config/1, %% target_params.conf target_params_entry/2, target_params_entry/4, target_params_entry/5, write_target_params_config/2, write_target_params_config/3, append_target_params_config/2, read_target_params_config/1, %% xyz.conf notify_entry/3, write_notify_config/2, write_notify_config/3, append_notify_config/2, read_notify_config/1, %% xyz.conf usm_entry/1, usm_entry/13, write_usm_config/2, write_usm_config/3, append_usm_config/2, read_usm_config/1, %% xyz.conf vacm_s2g_entry/3, vacm_acc_entry/8, vacm_vtf_entry/2, vacm_vtf_entry/4, write_vacm_config/2, write_vacm_config/3, append_vacm_config/2, read_vacm_config/1 ]). %% %% ------ agent.conf ------ %% agent_entry(Tag, Val) -> {Tag, Val}. write_agent_config(Dir, Conf) -> Comment = "%% This file defines the Agent local configuration info\n" "%% The data is inserted into the snmpEngine* variables defined\n" "%% in SNMP-FRAMEWORK-MIB, and the intAgent* variables defined\n" "%% in OTP-SNMPEA-MIB.\n" "%% Each row is a 2-tuple:\n" "%% {AgentVariable, Value}.\n" "%% For example\n" "%% {intAgentUDPPort, 4000}.\n" "%% The ip address for the agent is sent as id in traps.\n" "%% {intAgentIpAddress, [127,42,17,5]}.\n" "%% {snmpEngineID, \"agentEngine\"}.\n" "%% {snmpEngineMaxMessageSize, 484}.\n" "%%\n\n", Hdr = header() ++ Comment, write_agent_config(Dir, Hdr, Conf). write_agent_config(Dir, Hdr, Conf) when is_list(Dir) and is_list(Hdr) and is_list(Conf) -> Verify = fun() -> verify_agent_conf(Conf) end, Write = fun(Fd) -> write_agent_conf(Fd, Hdr, Conf) end, write_config_file(Dir, "agent.conf", Verify, Write). append_agent_config(Dir, Conf) when is_list(Dir) and is_list(Conf) -> Verify = fun() -> verify_agent_conf(Conf) end, Write = fun(Fd) -> write_agent_conf(Fd, Conf) end, append_config_file(Dir, "agent.conf", Verify, Write). read_agent_config(Dir) -> Verify = fun(Entry) -> verify_agent_conf_entry(Entry) end, read_config_file(Dir, "agent.conf", Verify). verify_agent_conf([]) -> ok; verify_agent_conf([H|T]) -> verify_agent_conf_entry(H), verify_agent_conf(T); verify_agent_conf(X) -> error({bad_agent_config, X}). verify_agent_conf_entry(Entry) -> ok = snmp_framework_mib:check_agent(Entry), ok. write_agent_conf(Fd, "", Conf) -> write_agent_conf(Fd, Conf); write_agent_conf(Fd, Hdr, Conf) -> io:format(Fd, "~s~n", [Hdr]), write_agent_conf(Fd, Conf). write_agent_conf(_Fd, []) -> ok; write_agent_conf(Fd, [H|T]) -> do_write_agent_conf(Fd, H), write_agent_conf(Fd, T). do_write_agent_conf(Fd, {intAgentIpAddress = Tag, Val}) -> io:format(Fd, "{~w, ~w}.~n", [Tag, Val]); do_write_agent_conf(Fd, {intAgentUDPPort = Tag, Val} ) -> io:format(Fd, "{~w, ~w}.~n", [Tag, Val]); do_write_agent_conf(Fd, {intAgentMaxPacketSize = Tag, Val} ) -> io:format(Fd, "{~w, ~w}.~n", [Tag, Val]); do_write_agent_conf(Fd, {snmpEngineMaxMessageSize = Tag, Val} ) -> io:format(Fd, "{~w, ~w}.~n", [Tag, Val]); do_write_agent_conf(Fd, {snmpEngineID = Tag, Val} ) -> io:format(Fd, "{~w, \"~s\"}.~n", [Tag, Val]); do_write_agent_conf(_Fd, Crap) -> error({bad_agent_config, Crap}). %% %% ------ context.conf ------ %% context_entry(Ctx) -> Ctx. write_context_config(Dir, Conf) -> Comment = "%% This file defines the contexts known to the agent.\n" "%% The data is inserted into the vacmContextTable defined\n" "%% in SNMP-VIEW-BASED-ACM-MIB.\n" "%% Each row is a string:\n" "%% ContextName.\n" "%%\n" "%% The empty string is the default context.\n" "%% For example\n" "%% \"bridge1\".\n" "%% \"bridge2\".\n" "%%\n\n", Hdr = header() ++ Comment, write_context_config(Dir, Hdr, Conf). write_context_config(Dir, Hdr, Conf) when is_list(Dir) and is_list(Hdr) and is_list(Conf) -> Verify = fun() -> verify_context_conf(Conf) end, Write = fun(Fd) -> write_context_conf(Fd, Hdr, Conf) end, write_config_file(Dir, "context.conf", Verify, Write). append_context_config(Dir, Conf) when is_list(Dir) and is_list(Conf) -> Verify = fun() -> verify_context_conf(Conf) end, Write = fun(Fd) -> write_context_conf(Fd, Conf) end, append_config_file(Dir, "context.conf", Verify, Write). read_context_config(Dir) -> Verify = fun(Entry) -> verify_context_conf_entry(Entry) end, read_config_file(Dir, "context.conf", Verify). verify_context_conf([]) -> ok; verify_context_conf([H|T]) -> verify_context_conf_entry(H), verify_context_conf(T); verify_context_conf(X) -> error({error_context_config, X}). verify_context_conf_entry(Context) -> {ok, _} = snmp_framework_mib:check_context(Context), ok. write_context_conf(Fd, "", Conf) -> write_context_conf(Fd, Conf); write_context_conf(Fd, Hdr, Conf) -> io:format(Fd, "~s~n", [Hdr]), write_context_conf(Fd, Conf). write_context_conf(_Fd, []) -> ok; write_context_conf(Fd, [H|T]) when is_list(H) -> io:format(Fd, "\"~s\".~n", [H]), write_context_conf(Fd, T); write_context_conf(_Fd, X) -> error({invalid_context_config, X}). %% %% ------ community.conf ------ %% community_entry(CommIndex) when CommIndex == "public" -> CommName = CommIndex, SecName = "initial", CtxName = "", TransportTag = "", community_entry(CommIndex, CommName, SecName, CtxName, TransportTag); community_entry(CommIndex) when CommIndex == "all-rights" -> CommName = CommIndex, SecName = CommIndex, CtxName = "", TransportTag = "", community_entry(CommIndex, CommName, SecName, CtxName, TransportTag). community_entry(CommIndex, CommName, SecName, CtxName, TransportTag) -> {CommIndex, CommName, SecName, CtxName, TransportTag}. write_community_config(Dir, Conf) -> Comment = "%% This file defines the community info which maps to VACM parameters.\n" "%% The data is inserted into the snmpCommunityTable defined\n" "%% in SNMP-COMMUNITY-MIB.\n" "%% Each row is a 5-tuple:\n" "%% {CommunityIndex, CommunityName, SecurityName, ContextName, TransportTag}.\n" "%% For example\n" "%% {\"1\", \"public\", \"initial\", \"\", \"\"}.\n" "%% {\"2\", \"secret\", \"secret_name\", \"\", \"tag\"}.\n" "%% {\"3\", \"bridge1\", \"initial\", \"bridge1\", \"\"}.\n" "%%\n\n", Hdr = header() ++ Comment, write_community_config(Dir, Hdr, Conf). write_community_config(Dir, Hdr, Conf) when is_list(Dir) and is_list(Hdr) and is_list(Conf) -> Verify = fun() -> verify_community_conf(Conf) end, Write = fun(Fd) -> write_community_conf(Fd, Hdr, Conf) end, write_config_file(Dir, "community.conf", Verify, Write). append_community_config(Dir, Conf) when is_list(Dir) and is_list(Conf) -> Verify = fun() -> verify_community_conf(Conf) end, Write = fun(Fd) -> write_community_conf(Fd, Conf) end, append_config_file(Dir, "community.conf", Verify, Write). read_community_config(Dir) -> Verify = fun(Entry) -> verify_community_conf_entry(Entry) end, read_config_file(Dir, "community.conf", Verify). verify_community_conf([]) -> ok; verify_community_conf([H|T]) -> verify_community_conf_entry(H), verify_community_conf(T); verify_community_conf(X) -> error({invalid_community_config, X}). verify_community_conf_entry(Context) -> {ok, _} = snmp_community_mib:check_community(Context), ok. write_community_conf(Fd, "", Conf) -> write_community_conf(Fd, Conf); write_community_conf(Fd, Hdr, Conf) -> io:format(Fd, "~s~n", [Hdr]), write_community_conf(Fd, Conf). write_community_conf(Fd, Conf) -> Fun = fun({Idx, Name, SecName, CtxName, TranspTag}) -> io:format(Fd, "{\"~s\", \"~s\", \"~s\", \"~s\", \"~s\"}.~n", [Idx, Name, SecName, CtxName, TranspTag]); (Crap) -> error({bad_community_config, Crap}) end, lists:foreach(Fun, Conf). %% %% ------ standard.conf ------ %% standard_entry(Tag, Val) -> {Tag, Val}. write_standard_config(Dir, Conf) -> Comment = "%% This file defines the STANDARD-MIB info.\n" "%% Each row is a 2-tuple:\n" "%% {StandardVariable, Value}.\n" "%% For example\n" "%% {sysDescr, \"Erlang SNMP agent\"}.\n" "%% {sysObjectID, [1,2,3]}.\n" "%% {sysContact, \"{mbj,eklas}@erlang.ericsson.se\"}.\n" "%% {sysName, \"test\"}.\n" "%% {sysLocation, \"erlang\"}.\n" "%% {sysServices, 72}.\n" "%% {snmpEnableAuthenTraps, enabled}.\n" "%%\n\n", Hdr = header() ++ Comment, write_standard_config(Dir, Hdr, Conf). write_standard_config(Dir, Hdr, Conf) when is_list(Dir) and is_list(Hdr) and is_list(Conf) -> Verify = fun() -> verify_standard_conf(Conf) end, Write = fun(Fd) -> write_standard_conf(Fd, Hdr, Conf) end, write_config_file(Dir, "standard.conf", Verify, Write). append_standard_config(Dir, Conf) when is_list(Dir) and is_list(Conf) -> Verify = fun() -> verify_standard_conf(Conf) end, Write = fun(Fd) -> write_standard_conf(Fd, Conf) end, append_config_file(Dir, "standard.conf", Verify, Write). read_standard_config(Dir) -> Verify = fun(Entry) -> verify_standard_conf_entry(Entry) end, read_config_file(Dir, "standard.conf", Verify). verify_standard_conf([]) -> ok; verify_standard_conf([H|T]) -> verify_standard_conf_entry(H), verify_standard_conf(T); verify_standard_conf(X) -> error({bad_standard_config, X}). verify_standard_conf_entry(Std) -> case snmp_standard_mib:check_standard(Std) of ok -> ok; {ok, _} -> ok end. write_standard_conf(Fd, "", Conf) -> write_standard_conf(Fd, Conf); write_standard_conf(Fd, Hdr, Conf) -> io:format(Fd, "~s~n", [Hdr]), write_standard_conf(Fd, Conf). write_standard_conf(Fd, Conf) -> Fun = fun({Tag, Val}) -> do_write_standard_conf(Fd, Tag, Val) end, lists:foreach(Fun, Conf). do_write_standard_conf(Fd, sysDescr = Tag, Val) -> io:format(Fd, "{~w, \"~s\"}.~n", [Tag, Val]); do_write_standard_conf(Fd, sysObjectID = Tag, Val) -> io:format(Fd, "{~w, ~w}.~n", [Tag, Val]); do_write_standard_conf(Fd, sysContact = Tag, Val) -> io:format(Fd, "{~w, \"~s\"}.~n", [Tag, Val]); do_write_standard_conf(Fd, sysName = Tag, Val) -> io:format(Fd, "{~w, \"~s\"}.~n", [Tag, Val]); do_write_standard_conf(Fd, sysLocation = Tag, Val) -> io:format(Fd, "{~w, \"~s\"}.~n", [Tag, Val]); do_write_standard_conf(Fd, sysServices = Tag, Val) -> io:format(Fd, "{~w, ~w}.~n", [Tag, Val]); do_write_standard_conf(Fd, snmpEnableAuthenTraps = Tag, Val) -> io:format(Fd, "{~w, ~w}.~n", [Tag, Val]); do_write_standard_conf(_Fd, Tag, Val) -> error({bad_standard_config, {Tag, Val}}). %% %% ------ target_addr.conf ------ %% target_addr_entry(Name, Ip, TagList, ParamsName, EngineId) -> target_addr_entry(Name, Ip, TagList, ParamsName, EngineId, []). target_addr_entry(Name, Ip, TagList, ParamsName, EngineId, TMask) -> target_addr_entry(Name, Ip, 162, TagList, ParamsName, EngineId, TMask, 2048). target_addr_entry(Name, Ip, Udp, TagList, ParamsName, EngineId, TMask, MaxMessageSize) -> target_addr_entry(Name, Ip, Udp, 1500, 3, TagList, ParamsName, EngineId, TMask, MaxMessageSize). target_addr_entry(Name, Ip, Udp, Timeout, RetryCount, TagList, ParamsName, EngineId, TMask, MaxMessageSize) -> target_addr_entry(Name, snmp_target_mib:default_domain(), Ip, Udp, Timeout, RetryCount, TagList, ParamsName, EngineId, TMask, MaxMessageSize). target_addr_entry(Name, Domain, Ip, Udp, Timeout, RetryCount, TagList, ParamsName, EngineId, TMask, MaxMessageSize) -> {Name, Domain, Ip, Udp, Timeout, RetryCount, TagList, ParamsName, EngineId, TMask, MaxMessageSize}. write_target_addr_config(Dir, Conf) -> Comment = "%% This file defines the target address parameters.\n" "%% The data is inserted into the snmpTargetAddrTable defined\n" "%% in SNMP-TARGET-MIB, and in the snmpTargetAddrExtTable defined\n" "%% in SNMP-COMMUNITY-MIB.\n" "%% Each row is a 10 or 11-tuple (Domain is optional):\n" "%% {Name, \n" "%% Domain, Ip, Port, \n" "%% Timeout, RetryCount, TagList, ParamsName, EngineId,\n" "%% TMask, MaxMessageSize}.\n" "%% The value of Domain decide the format of the Ip and TMask values. \n" "%% If not present, classic Ipv4 is assumed. \n" "%% The EngineId value is only used if Inform-Requests are sent to this\n" "%% target. If Informs are not sent, this value is ignored, and can be\n" "%% e.g. an empty string. However, if Informs are sent, it is essential\n" "%% that the value of EngineId matches the value of the target's\n" "%% actual snmpEngineID.\n" "%% For example\n" "%% {\"1.2.3.4 v1\", [1,2,3,4], 162, \n" "%% 1500, 3, \"std_inform\", \"otp_v2\", \"\",\n" "%% [127,0,0,0], 2048}.\n" "%%\n\n", Hdr = header() ++ Comment, write_target_addr_config(Dir, Hdr, Conf). write_target_addr_config(Dir, Hdr, Conf) when is_list(Dir) and is_list(Hdr) and is_list(Conf) -> Verify = fun() -> verify_target_addr_conf(Conf) end, Write = fun(Fd) -> write_target_addr_conf(Fd, Hdr, Conf) end, write_config_file(Dir, "target_addr.conf", Verify, Write). append_target_addr_config(Dir, Conf) when is_list(Dir) and is_list(Conf) -> Verify = fun() -> verify_target_addr_conf(Conf) end, Write = fun(Fd) -> write_target_addr_conf(Fd, Conf) end, append_config_file(Dir, "target_addr.conf", Verify, Write). read_target_addr_config(Dir) -> Verify = fun(Entry) -> verify_target_addr_conf_entry(Entry) end, read_config_file(Dir, "target_addr.conf", Verify). verify_target_addr_conf([]) -> ok; verify_target_addr_conf([H|T]) -> verify_target_addr_conf_entry(H), verify_target_addr_conf(T); verify_target_addr_conf(X) -> error({bad_target_addr_config, X}). verify_target_addr_conf_entry(Entry) -> {ok, _} = snmp_target_mib:check_target_addr(Entry), ok. write_target_addr_conf(Fd, "", Conf) -> write_target_addr_conf(Fd, Conf); write_target_addr_conf(Fd, Hdr, Conf) -> io:format(Fd, "~s~n", [Hdr]), write_target_addr_conf(Fd, Conf). write_target_addr_conf(Fd, Conf) -> Fun = fun(Entry) -> do_write_target_addr_conf(Fd, Entry) end, lists:foreach(Fun, Conf), ok. do_write_target_addr_conf(Fd, {Name, Ip, Udp, Timeout, RetryCount, TagList, ParamsName, EngineId, TMask, MaxMessageSize}) -> Domain = snmp_target_mib:default_domain(), do_write_target_addr_conf(Fd, {Name, Domain, Ip, Udp, Timeout, RetryCount, TagList, ParamsName, EngineId, TMask, MaxMessageSize}); do_write_target_addr_conf(Fd, {Name, Domain, Ip, Udp, Timeout, RetryCount, TagList, ParamsName, EngineId, TMask, MaxMessageSize}) -> io:format(Fd, "{\"~s\", ~w, ~w, ~w, ~w, ~w, \"~s\", \"~s\", \"~s\", ~w, ~w}.~n", [Name, Domain, Ip, Udp, Timeout, RetryCount, TagList, ParamsName, EngineId, TMask, MaxMessageSize]); do_write_target_addr_conf(_Fd, Crap) -> error({bad_target_addr_config, Crap}). %% %% ------ target_params.conf ------ %% target_params_entry(Name, Vsn) -> SecName = "initial", SecLevel = noAuthNoPriv, target_params_entry(Name, Vsn, SecName, SecLevel). target_params_entry(Name, Vsn, SecName, SecLevel) -> MPModel = if Vsn =:= v1 -> v1; Vsn =:= v2 -> v2c; Vsn =:= v3 -> v3 end, SecModel = if Vsn =:= v1 -> v1; Vsn =:= v2 -> v2c; Vsn =:= v3 -> usm end, target_params_entry(Name, MPModel, SecModel, SecName, SecLevel). target_params_entry(Name, MPModel, SecModel, SecName, SecLevel) -> {Name, MPModel, SecModel, SecName, SecLevel}. write_target_params_config(Dir, Conf) -> Comment = "%% This file defines the target parameters.\n" "%% The data is inserted into the snmpTargetParamsTable defined\n" "%% in SNMP-TARGET-MIB.\n" "%% Each row is a 5-tuple:\n" "%% {Name, MPModel, SecurityModel, SecurityName, SecurityLevel}.\n" "%% For example\n" "%% {\"target_v3\", v3, usm, \"\", noAuthNoPriv}.\n" "%%\n\n", Hdr = header() ++ Comment, write_target_params_config(Dir, Hdr, Conf). write_target_params_config(Dir, Hdr, Conf) when is_list(Dir) and is_list(Hdr) and is_list(Conf) -> Verify = fun() -> verify_target_params_conf(Conf) end, Write = fun(Fd) -> write_target_params_conf(Fd, Hdr, Conf) end, write_config_file(Dir, "target_params.conf", Verify, Write). append_target_params_config(Dir, Conf) when is_list(Dir) and is_list(Conf) -> Verify = fun() -> verify_target_params_conf(Conf) end, Write = fun(Fd) -> write_target_params_conf(Fd, Conf) end, append_config_file(Dir, "target_params.conf", Verify, Write). read_target_params_config(Dir) -> Verify = fun(Entry) -> verify_target_params_conf_entry(Entry) end, read_config_file(Dir, "target_params.conf", Verify). verify_target_params_conf([]) -> ok; verify_target_params_conf([H|T]) -> verify_target_params_conf_entry(H), verify_target_params_conf(T); verify_target_params_conf(X) -> error({bad_target_params_config, X}). verify_target_params_conf_entry(Entry) -> {ok, _} = snmp_target_mib:check_target_params(Entry), ok. write_target_params_conf(Fd, "", Conf) -> write_target_params_conf(Fd, Conf); write_target_params_conf(Fd, Hdr, Conf) -> io:format(Fd, "~s~n", [Hdr]), write_target_params_conf(Fd, Conf). write_target_params_conf(Fd, Conf) -> Fun = fun(Entry) -> do_write_target_params_conf(Fd, Entry) end, lists:foreach(Fun, Conf). do_write_target_params_conf(Fd, {Name, MpModel, SecModel, SecName, SecLevel}) -> io:format(Fd, "{\"~s\", ~w, ~w, \"~s\", ~w}.~n", [Name, MpModel, SecModel, SecName, SecLevel]); do_write_target_params_conf(_Fd, Crap) -> error({bad_target_params_config, Crap}). %% %% ------ notify.conf ------ %% notify_entry(Name, Tag, Type) -> {Name, Tag, Type}. write_notify_config(Dir, Conf) -> Comment = "%% This file defines the notification parameters.\n" "%% The data is inserted into the snmpNotifyTable defined\n" "%% in SNMP-NOTIFICATION-MIB.\n" "%% The Name is used as CommunityString for v1 and v2c.\n" "%% Each row is a 3-tuple:\n" "%% {Name, Tag, Type}.\n" "%% For example\n" "%% {\"standard trap\", \"std_trap\", trap}.\n" "%% {\"standard inform\", \"std_inform\", inform}.\n" "%%\n\n", Hdr = header() ++ Comment, write_notify_config(Dir, Hdr, Conf). write_notify_config(Dir, Hdr, Conf) when is_list(Dir) and is_list(Hdr) and is_list(Conf) -> Verify = fun() -> verify_notify_conf(Conf) end, Write = fun(Fd) -> write_notify_conf(Fd, Hdr, Conf) end, write_config_file(Dir, "notify.conf", Verify, Write). append_notify_config(Dir, Conf) when is_list(Dir) and is_list(Conf) -> Verify = fun() -> verify_notify_conf(Conf) end, Write = fun(Fd) -> write_notify_conf(Fd, Conf) end, append_config_file(Dir, "notify.conf", Verify, Write). read_notify_config(Dir) -> Verify = fun(Entry) -> verify_notify_conf_entry(Entry) end, read_config_file(Dir, "notify.conf", Verify). verify_notify_conf([]) -> ok; verify_notify_conf([H|T]) -> verify_notify_conf_entry(H), verify_notify_conf(T); verify_notify_conf(X) -> error({bad_notify_config, X}). verify_notify_conf_entry(Entry) -> {ok, _} = snmp_notification_mib:check_notify(Entry), ok. write_notify_conf(Fd, "", Conf) -> write_notify_conf(Fd, Conf); write_notify_conf(Fd, Hdr, Conf) -> io:format(Fd, "~s~n", [Hdr]), write_notify_conf(Fd, Conf). write_notify_conf(Fd, Conf) -> Fun = fun(Entry) -> do_write_notify_conf(Fd, Entry) end, lists:foreach(Fun, Conf). do_write_notify_conf(Fd, {Name, Tag, Type}) -> io:format(Fd, "{\"~s\", \"~s\", ~w}.~n", [Name, Tag, Type]); do_write_notify_conf(_Fd, Crap) -> error({bad_notify_config, Crap}). %% %% ------ usm.conf ------ %% usm_entry(EngineID) -> UserName = "initial", SecName = "initial", Clone = zeroDotZero, AuthP = usmNoAuthProtocol, AuthKeyC = "", OwnAuthKeyC = "", PrivP = usmNoPrivProtocol, PrivKeyC = "", OwnPrivKeyC = "", Public = "", AuthKey = "", PrivKey = "", usm_entry(EngineID, UserName, SecName, Clone, AuthP, AuthKeyC, OwnAuthKeyC, PrivP, PrivKeyC, OwnPrivKeyC, Public, AuthKey, PrivKey). usm_entry(EngineID, UserName, SecName, Clone, AuthP, AuthKeyC, OwnAuthKeyC, PrivP, PrivKeyC, OwnPrivKeyC, Public, AuthKey, PrivKey) -> {EngineID, UserName, SecName, Clone, AuthP, AuthKeyC, OwnAuthKeyC, PrivP, PrivKeyC, OwnPrivKeyC, Public, AuthKey, PrivKey}. write_usm_config(Dir, Conf) -> Comment = "%% This file defines the security parameters for the user-based\n" "%% security model.\n" "%% The data is inserted into the usmUserTable defined\n" "%% in SNMP-USER-BASED-SM-MIB.\n" "%% Each row is a 13-tuple:\n" "%% {EngineID, UserName, SecName, Clone, AuthP, AuthKeyC, OwnAuthKeyC,\n" "%% PrivP, PrivKeyC, OwnPrivKeyC, Public, AuthKey, PrivKey}.\n" "%% For example\n" "%% {\"agentEngine\", \"initial\", \"initial\", zeroDotZero,\n" "%% usmNoAuthProtocol, \"\", \"\", usmNoPrivProtocol, \"\", \"\", \"\",\n" "%% \"\", \"\"}.\n" "%%\n\n", Hdr = header() ++ Comment, write_usm_config(Dir, Hdr, Conf). write_usm_config(Dir, Hdr, Conf) when is_list(Dir) and is_list(Hdr) and is_list(Conf) -> Verify = fun() -> verify_usm_conf(Conf) end, Write = fun(Fd) -> write_usm_conf(Fd, Hdr, Conf) end, write_config_file(Dir, "usm.conf", Verify, Write). append_usm_config(Dir, Conf) when is_list(Dir) and is_list(Conf) -> Verify = fun() -> verify_usm_conf(Conf) end, Write = fun(Fd) -> write_usm_conf(Fd, Conf) end, append_config_file(Dir, "usm.conf", Verify, Write). read_usm_config(Dir) -> Verify = fun(Entry) -> verify_usm_conf_entry(Entry) end, read_config_file(Dir, "usm.conf", Verify). verify_usm_conf([]) -> ok; verify_usm_conf([H|T]) -> verify_usm_conf_entry(H), verify_usm_conf(T); verify_usm_conf(X) -> error({bad_usm_conf, X}). verify_usm_conf_entry(Entry) -> {ok, _} = snmp_user_based_sm_mib:check_usm(Entry), ok. write_usm_conf(Fd, "", Conf) -> write_usm_conf(Fd, Conf); write_usm_conf(Fd, Hdr, Conf) -> io:format(Fd, "~s~n", [Hdr]), write_usm_conf(Fd, Conf). write_usm_conf(Fd, Conf) -> Fun = fun(Entry) -> do_write_usm_conf(Fd, Entry) end, lists:foreach(Fun, Conf). do_write_usm_conf(Fd, {EngineID, UserName, SecName, Clone, AuthP, AuthKeyC, OwnAuthKeyC, PrivP, PrivKeyC, OwnPrivKeyC, Public, AuthKey, PrivKey}) -> io:format(Fd, "{", []), io:format(Fd, "\"~s\", ", [EngineID]), io:format(Fd, "\"~s\", ", [UserName]), io:format(Fd, "\"~s\", ", [SecName]), io:format(Fd, "~w, ", [Clone]), io:format(Fd, "~w, ", [AuthP]), do_write_usm2(Fd, AuthKeyC, ", "), do_write_usm2(Fd, OwnAuthKeyC, ", "), io:format(Fd, "~w, ", [PrivP]), do_write_usm2(Fd, PrivKeyC, ", "), do_write_usm2(Fd, OwnPrivKeyC, ", "), do_write_usm2(Fd, Public, ", "), do_write_usm2(Fd, AuthKey, ", "), do_write_usm2(Fd, PrivKey, ""), io:format(Fd, "}.~n", []); do_write_usm_conf(_Fd, Crap) -> error({bad_usm_config, Crap}). do_write_usm2(Fd, "", P) -> io:format(Fd, "\"\"~s", [P]); do_write_usm2(Fd, X, P) -> io:format(Fd, "~w~s", [X, P]). %% %% ------ vacm.conf ------ %% vacm_s2g_entry(SecModel, SecName, GroupName) -> {vacmSecurityToGroup, SecModel, SecName, GroupName}. vacm_acc_entry(GroupName, Prefix, SecModel, SecLevel, Match, RV, WV, NV) -> {vacmAccess, GroupName, Prefix, SecModel, SecLevel, Match, RV, WV, NV}. vacm_vtf_entry(ViewIndex, ViewSubtree) -> vacm_vtf_entry(ViewIndex, ViewSubtree, included, null). vacm_vtf_entry(ViewIndex, ViewSubtree, ViewStatus, ViewMask) -> {vacmViewTreeFamily, ViewIndex, ViewSubtree, ViewStatus, ViewMask}. write_vacm_config(Dir, Conf) -> Comment = "%% This file defines the Mib Views.\n" "%% The data is inserted into the vacm* tables defined\n" "%% in SNMP-VIEW-BASED-ACM-MIB.\n" "%% Each row is one of 3 tuples; one for each table in the MIB:\n" "%% {vacmSecurityToGroup, SecModel, SecName, GroupName}.\n" "%% {vacmAccess, GroupName, Prefix, SecModel, SecLevel, Match, RV, WV, NV}.\n" "%% {vacmViewTreeFamily, ViewIndex, ViewSubtree, ViewStatus, ViewMask}.\n" "%% For example\n" "%% {vacmSecurityToGroup, v2c, \"initial\", \"initial\"}.\n" "%% {vacmSecurityToGroup, usm, \"initial\", \"initial\"}.\n" "%% read/notify access to system\n" "%% {vacmAccess, \"initial\", \"\", any, noAuthNoPriv, exact,\n" "%% \"system\", \"\", \"system\"}.\n" "%% {vacmViewTreeFamily, \"system\", [1,3,6,1,2,1,1], included, null}.\n" "%% {vacmViewTreeFamily, \"exmib\", [1,3,6,1,3], included, null}." " % for EX1-MIB\n" "%% {vacmViewTreeFamily, \"internet\", [1,3,6,1], included, null}.\n" "%%\n\n", Hdr = header() ++ Comment, write_vacm_config(Dir, Hdr, Conf). write_vacm_config(Dir, Hdr, Conf) when is_list(Dir) and is_list(Hdr) and is_list(Conf) -> Verify = fun() -> verify_vacm_conf(Conf) end, Write = fun(Fd) -> write_vacm_conf(Fd, Hdr, Conf) end, write_config_file(Dir, "vacm.conf", Verify, Write). append_vacm_config(Dir, Conf) when is_list(Dir) and is_list(Conf) -> Verify = fun() -> verify_vacm_conf(Conf) end, Write = fun(Fd) -> write_vacm_conf(Fd, Conf) end, append_config_file(Dir, "vacm.conf", Verify, Write). read_vacm_config(Dir) -> Verify = fun(Entry) -> verify_vacm_conf_entry(Entry) end, read_config_file(Dir, "vacm.conf", Verify). verify_vacm_conf([]) -> ok; verify_vacm_conf([H|T]) -> verify_vacm_conf_entry(H), verify_vacm_conf(T); verify_vacm_conf(X) -> error({bad_vacm_conf, X}). verify_vacm_conf_entry(Entry) -> {ok, _} = snmp_view_based_acm_mib:check_vacm(Entry), ok. write_vacm_conf(Fd, "", Conf) -> write_vacm_conf(Fd, Conf); write_vacm_conf(Fd, Hdr, Conf) -> io:format(Fd, "~s~n", [Hdr]), write_vacm_conf(Fd, Conf). write_vacm_conf(Fd, Conf) -> Fun = fun(Entry) -> do_write_vacm_conf(Fd, Entry) end, lists:foreach(Fun, Conf). do_write_vacm_conf(Fd, {vacmSecurityToGroup, SecModel, SecName, GroupName}) -> io:format(Fd, "{vacmSecurityToGroup, ~w, \"~s\", \"~s\"}.~n", [SecModel, SecName, GroupName]); do_write_vacm_conf(Fd, {vacmAccess, GroupName, Prefix, SecModel, SecLevel, Match, RV, WV, NV}) -> io:format(Fd, "{vacmAccess, \"~s\", \"~s\", ~w, ~w, ~w, " "\"~s\", \"~s\", \"~s\"}.~n", [GroupName, Prefix, SecModel, SecLevel, Match, RV, WV, NV]); do_write_vacm_conf(Fd, {vacmViewTreeFamily, ViewIndex, ViewSubtree, ViewStatus, ViewMask}) -> io:format(Fd, "{vacmViewTreeFamily, \"~s\", ~w, ~w, ~w}.~n", [ViewIndex, ViewSubtree, ViewStatus, ViewMask]); do_write_vacm_conf(_Fd, Crap) -> error({bad_vacm_config, Crap}). %% ---- config file wrapper functions ---- write_config_file(Dir, File, Verify, Write) -> snmp_config:write_config_file(Dir, File, Verify, Write). append_config_file(Dir, File, Verify, Write) -> snmp_config:append_config_file(Dir, File, Verify, Write). read_config_file(Dir, File, Verify) -> snmp_config:read_config_file(Dir, File, Verify). %% ---- config file utility functions ---- header() -> {Y,Mo,D} = date(), {H,Mi,S} = time(), io_lib:format("%% This file was generated by " "~w (version-~s) ~w-~2.2.0w-~2.2.0w " "~2.2.0w:~2.2.0w:~2.2.0w\n", [?MODULE, ?version, Y, Mo, D, H, Mi, S]). error(R) -> throw({error, R}).