1.\"- 2.\" Copyright (C) 2010 The FreeBSD Foundation 3.\" 4.\" This documentation was written by Shteryana Sotirova Shopova under 5.\" sponsorship from the FreeBSD Foundation. 6.\" 7.\" Redistribution and use in source and binary forms, with or without 8.\" modification, are permitted provided that the following conditions 9.\" are met: 10.\" 1. Redistributions of source code must retain the above copyright 11.\" notice, this list of conditions and the following disclaimer. 12.\" 2. Redistributions in binary form must reproduce the above copyright 13.\" notice, this list of conditions and the following disclaimer in the 14.\" documentation and/or other materials provided with the distribution. 15.\" 16.\" THIS SOFTWARE IS PROVIDED BY AUTHOR AND CONTRIBUTORS ``AS IS'' AND 17.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 18.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 19.\" ARE DISCLAIMED. IN NO EVENT SHALL AUTHOR OR CONTRIBUTORS BE LIABLE 20.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 21.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 22.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 23.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 24.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 25.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 26.\" SUCH DAMAGE. 27.\" 28.\" $FreeBSD$ 29.\" 30.Dd October 7, 2010 31.Dt SNMP_VACM 3 32.Os 33.Sh NAME 34.Nm snmp_vacm 35.Nd "View-based Access Control module for" 36.Xr bsnmpd 1 37.Sh LIBRARY 38.Pq begemotSnmpdModulePath."vacm" = "/usr/lib/snmp_vacm.so" 39.Sh DESCRIPTION 40The 41.Nm snmp_vacm 42module implements SNMPv3 View-based Access Control Model MIB as defined in 43RFC 3415. The module is used to manage the internal lists of SNMPv1, v2c and 44v3 user names and groups and their access rights to fetch or modify the values 45of the MIB objects maintained by 46.Nm bsnmpd 47and the modules loaded in the daemon. 48The module must be loaded for 49.Nm bsnmpd 50to implement proper view-based access control. If the module is not loaded, 51access is granted to all configured SNMPv1 & SNMPv2c communities and SNMPv3 52USM users. 53.Sh IMPLEMENTATION NOTES 54An entry in any table implemented by this MIB may be created by setting the 55relevant RowStatus column to createAndGo (4) - in fact, any other value for 56those columns in a SET operation will cause an error. When an entry is created, 57any of its columns that is not used as index, is set to the default value as 58specified in the SNMP-VIEW-BASED-ACM-MIB. All entries maintained by the module 59are persistent after reboot if created via 60.Nm bsnmpd 's 61config file, otherwise entries created via SNMP are lost after reboot. 62A short description of the objects in the MIB follows. 63.Bl -tag -width "XXXXXXXXX" 64.It Va vacmContextTable 65A read-only table that consists of a list of SNMP contexts available in 66.Nm bsnmpd . 67.It Va vacmSecurityToGroupTable 68The table contains a list of SNMPv1, v2c and v3 user names and the groups 69they belong to. 70.It Va vacmAccessTable 71The table contains a list of SNMP contexts to groups mappings and respectively 72the names of the SNMP views under those contexts, to which users in the group 73are granted read-only, read-write access or receive notifications for the 74objects under the subtree in the relevant view. 75.It Va vacmViewTreeFamilyTable 76The table contains a list of SNMP views, i.e. entries specifying the OID of a 77MIB subtree and whether access to the objects under this subtree is to be 78allowed or forbidden. 79.El 80.Sh FILES 81.Bl -tag -width "XXXXXXXXX" 82.It Pa /usr/share/snmp/defs/vacm_tree.def 83The description of the MIB tree implemented by 84.Nm . 85.El 86.Sh SEE ALSO 87.Xr bsnmpd 1 , 88.Xr gensnmptree 1 , 89.Xr snmpmod 3 90.Sh STANDARDS 91IETF RFC 3415 92.Sh AUTHORS 93.An Shteryana Shopova Aq syrinx@FreeBSD.org 94