261 lines · 9.2 KB · C#
RawDownload
// TRAP message type (SNMP version 1 only).// Copyright (C) 2008-2010 Malcolm Crowe, Lex Li, and other contributors.// // Permission is hereby granted, free of charge, to any person obtaining a copy of this// software and associated documentation files (the "Software"), to deal in the Software// without restriction, including without limitation the rights to use, copy, modify, merge,// publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons// to whom the Software is furnished to do so, subject to the following conditions:// // The above copyright notice and this permission notice shall be included in all copies or// substantial portions of the Software.// // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,// INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR// PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE// FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR// OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER// DEALINGS IN THE SOFTWARE. /* * Created by SharpDevelop. * User: lextm * Date: 2008/4/25 * Time: 20:30 *  * To change this template use Tools | Options | Coding | Edit Standard Headers. */ using System;using System.Collections.Generic;using System.Globalization;using System.Net;using GSF.Net.Snmp.Security; namespace GSF.Net.Snmp.Messaging{    /// <summary>    /// Trap message.    /// </summary>    public sealed class TrapV1Message : ISnmpMessage    {        private readonly ISnmpPdu _pdu;        private readonly Sequence _container;        private Scope _scope;         /// <summary>        /// Creates a <see cref="TrapV1Message"/> with all content.        /// </summary>        /// <param name="version">Protocol version</param>        /// <param name="agent">Agent address</param>        /// <param name="community">Community name</param>        /// <param name="enterprise">Enterprise</param>        /// <param name="generic">Generic</param>        /// <param name="specific">Specific</param>        /// <param name="time">Time</param>        /// <param name="variables">Variables</param>        [CLSCompliant(false)]        public TrapV1Message(VersionCode version, IPAddress agent, OctetString community, ObjectIdentifier enterprise, GenericCode generic, int specific, uint time, IList<Variable> variables)        {            if (variables == null)            {                throw new ArgumentNullException(nameof(variables));            }                        if (enterprise == null)            {                throw new ArgumentNullException(nameof(enterprise));            }                        if (community == null)            {                throw new ArgumentNullException(nameof(community));            }                        if (agent == null)            {                throw new ArgumentNullException(nameof(agent));            }                        if (version != VersionCode.V1)            {                throw new ArgumentException($"TRAP v1 is not supported in this SNMP version: {version}", nameof(version));            }                        Version = version;            AgentAddress = agent;            Community = community;            Enterprise = enterprise;            Generic = generic;            Specific = specific;            TimeStamp = time;            TrapV1Pdu pdu = new TrapV1Pdu(                Enterprise,                new IP(AgentAddress.GetAddressBytes()),                new Integer32((int)Generic),                new Integer32(Specific),                new TimeTicks(TimeStamp),                variables);            _pdu = pdu;            Parameters = SecurityParameters.Create(Community);        }                /// <summary>        /// Creates a <see cref="TrapV1Message"/> instance with a message body.        /// </summary>        /// <param name="body">Message body</param>        public TrapV1Message(Sequence body)        {            if (body == null)            {                throw new ArgumentNullException(nameof(body));            }                        if (body.Length != 3)            {                throw new ArgumentException("Invalid message body.", nameof(body));            }                        Community = (OctetString)body[1];            Version = (VersionCode)((Integer32)body[0]).ToInt32();                        // IMPORTANT: comment this check out if you need to support             if (Version != VersionCode.V1)            {                throw new ArgumentException($"TRAP v1 is not supported in this SNMP version: {Version}.", nameof(body));            }                                    _pdu = (ISnmpPdu)body[2];            if (_pdu.TypeCode != SnmpType.TrapV1Pdu)            {                throw new ArgumentException("Invalid message type.", nameof(body));            }             TrapV1Pdu trapPdu = (TrapV1Pdu)_pdu;            Enterprise = trapPdu.Enterprise;            AgentAddress = new IPAddress(trapPdu.AgentAddress.GetRaw());            Generic = trapPdu.Generic;            Specific = trapPdu.Specific;            TimeStamp = trapPdu.TimeStamp.ToUInt32();            Parameters = SecurityParameters.Create(Community);            _container = body;        }         /// <summary>        /// Time stamp.        /// </summary>        [CLSCompliant(false), System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Naming", "CA1702:CompoundWordsShouldBeCasedCorrectly", MessageId = "TimeStamp")]        public uint TimeStamp { get; private set; }         /// <summary>        /// Community name.        /// </summary>        public OctetString Community { get; private set; }         /// <summary>        /// Enterprise.        /// </summary>        public ObjectIdentifier Enterprise { get; private set; }         /// <summary>        /// Agent address.        /// </summary>        public IPAddress AgentAddress { get; private set; }         /// <summary>        /// Generic type.        /// </summary>        public GenericCode Generic { get; private set; }         /// <summary>        /// Specific type.        /// </summary>        public int Specific { get; private set; }         /// <summary>        /// Protocol version.        /// </summary>        public VersionCode Version { get; private set; }         /// <summary>        /// Gets the header.        /// </summary>        public Header Header         {             get { throw new NotSupportedException(); }        }                /// <summary>        /// Gets the privacy provider.        /// </summary>        public IPrivacyProvider Privacy        {            get { throw new NotSupportedException(); }        }         /// <summary>        /// To byte format.        /// </summary>        /// <returns></returns>        public byte[] ToBytes()        {            return _container == null ? PackMessage(Version, Community, _pdu).ToBytes() : _container.ToBytes();        }         /// <summary>        /// Gets the parameters.        /// </summary>        /// <value>The parameters.</value>        /// <remarks><see cref="TrapV1Message"/> returns null here.</remarks>        public SecurityParameters Parameters { get; private set; }         /// <summary>        /// Gets the scope.        /// </summary>        /// <value>The scope.</value>        /// <remarks><see cref="TrapV1Message"/> returns null here.</remarks>        public Scope Scope        {            get { return _scope ?? (_scope = new Scope(_pdu)); }        }                /// <summary>        /// Returns a <see cref="string"/> that represents the current <see cref="TrapV1Message"/>.        /// </summary>        /// <returns></returns>        public override string ToString()        {            TrapV1Pdu tempQualifier = ((TrapV1Pdu)_pdu);            return string.Format(                CultureInfo.InvariantCulture,                "SNMPv1 trap: {0}",                string.Format(                    CultureInfo.InvariantCulture,                    "SNMPv1 TRAP PDU: agent address: {0}; time stamp: {1}; enterprise: {2}; generic: {3}; specific: {4}; varbind count: {5}",                    tempQualifier.AgentAddress,                    tempQualifier.TimeStamp,                    tempQualifier.Enterprise,                    tempQualifier.Generic,                    tempQualifier.Specific.ToString(CultureInfo.InvariantCulture),                    tempQualifier.Variables.Count.ToString(CultureInfo.InvariantCulture)));        }         /// <summary>        /// Packs the message.        /// </summary>        /// <param name="version">The version.</param>        /// <param name="data">The data.</param>        /// <returns></returns>        internal static Sequence PackMessage(VersionCode version, params ISnmpData[] data)        {            if (data == null)            {                throw new ArgumentNullException(nameof(data));            }                        List<ISnmpData> collection = new List<ISnmpData>(1 + data.Length) { new Integer32((int)version) };            collection.AddRange(data);            return new Sequence(collection);        }    }}

Keyboard shortcuts

General

Show keyboard shortcuts
?
Focus the current search
/

Issues and pull requests

Open filters
f

Issues, pull requests and Inbox

Select next item
j↓
Select previous item
k↑
Open selected item
Enter
Dismiss filters or clear selection
Esc

Repository code

Go to file
t