pegasus/src/Pegasus/Handler/snmpIndicationHandler/snmpIndicationHandler.cpp - diff

Return to snmpIndicationHandler.cpp CVS log

Up to [Pegasus] / pegasus / src / Pegasus / Handler / snmpIndicationHandler

Diff for /pegasus/src/Pegasus/Handler/snmpIndicationHandler/snmpIndicationHandler.cpp between version 1.16 and 1.46

version 1.16, 2003/08/14 15:23:47

version 1.46, 2013/07/01 10:55:54

Line 1

//%/////////////////////////////////////////////////////////////////////////////

//%LICENSE////////////////////////////////////////////////////////////////

// Licensed to The Open Group (TOG) under one or more contributor license

// agreements. Refer to the OpenPegasusNOTICE.txt file distributed with

// this work for additional information regarding copyright ownership.

// Each contributor licenses this file to you under the OpenPegasus Open

// Source License; you may not use this file except in compliance with the

// License.

// 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

// The Open Group, Tivoli Systems

// 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.

// 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.

//==============================================================================

// Author: Nitin Upasani, Hewlett-Packard Company (Nitin_Upasani@hp.com)

// Modified By: Carol Ann Krug Graves, Hewlett-Packard Company

// (carolann_graves@hp.com)

// : Yi Zhou, Hewlett-Packard Company (yi_zhou@hp.com)

//%/////////////////////////////////////////////////////////////////////////////

Line 35

#include <iostream>

#include <Pegasus/Handler/CIMHandler.h>

#include <Pegasus/Repository/CIMRepository.h>

#include <Pegasus/Common/Tracer.h>

#include "snmpIndicationHandler.h"

#ifdef HPUX_EMANATE

#include "snmpDeliverTrap_emanate.h"

#else

#elif defined (PEGASUS_USE_NET_SNMP)

#include "snmpDeliverTrap_stub.h"

# include "snmpDeliverTrap_netsnmp.h"

#endif

// l10n

#include <Pegasus/Common/MessageLoader.h>

PEGASUS_USING_STD;

PEGASUS_NAMESPACE_BEGIN

PEGASUS_USING_STD;

snmpIndicationHandler::snmpIndicationHandler()

{

PEG_METHOD_ENTER (TRC_IND_HANDLER,

"snmpIndicationHandler::snmpIndicationHandler");

#ifdef HPUX_EMANATE

_snmpTrapSender = new snmpDeliverTrap_emanate();

#elif defined (PEGASUS_USE_NET_SNMP)

_snmpTrapSender = new snmpDeliverTrap_netsnmp();

#endif

PEG_METHOD_EXIT();

}

void snmpIndicationHandler::initialize(CIMRepository* repository)

{

PEG_METHOD_ENTER (TRC_IND_HANDLER,

"snmpIndicationHandler::initialize");

_repository = repository;

_snmpTrapSender->initialize();

PEG_METHOD_EXIT();

}

void snmpIndicationHandler::terminate()

{

PEG_METHOD_ENTER(TRC_IND_HANDLER,

"snmpIndicationHandler::terminate");

_snmpTrapSender->terminate();

PEG_METHOD_EXIT();

}

snmpIndicationHandler::~snmpIndicationHandler()

{

PEG_METHOD_ENTER(TRC_IND_HANDLER,

"snmpIndicationHandler::~snmpIndicationHandler");

delete _snmpTrapSender;

PEG_METHOD_EXIT();

}

// l10n - note: ignoring indication language

void snmpIndicationHandler::handleIndication(

const OperationContext& context,

const String nameSpace,

CIMInstance& indication,

CIMInstance& handler,

CIMInstance& indication, String nameSpace,

CIMInstance& subscription,

ContentLanguages & contentLanguages)

ContentLanguageList & contentLanguages)

{

Array<String> propOIDs;

Array<String> propTYPEs;

Array<String> propVALUEs;

CIMProperty prop;

Array<String> mapStr;

CIMQualifier trapQualifier;

Uint32 qualifierPos;

String propValue;

PEG_METHOD_ENTER(TRC_IND_HANDLER,

"snmpIndicationHandler::handleIndication");

String mapstr1;

String mapstr2;

try

{

PEG_TRACE ((TRC_INDICATION_GENERATION, Tracer::LEVEL4,

"snmpIndicationHandler %s:%s.%s processing %s Indication",

(const char*)(nameSpace.getCString()),

(const char*)(handler.getClassName().getString().getCString()),

(const char*)(handler.getProperty(

handler.findProperty(PEGASUS_PROPERTYNAME_NAME)).

getValue().toString().getCString()),

(const char*)(indication.getClassName().getString().

getCString())));

CIMClass indicationClass = _repository->getClass(

nameSpace, indication.getClassName(), false);

nameSpace, indication.getClassName(), false, true,

false, CIMPropertyList());

Uint32 propertyCount = indication.getPropertyCount();

for (Uint32 i=0; i < propertyCount; i++)

{

prop = indication.getProperty(i);

CIMProperty prop = indication.getProperty(i);

if (!prop.isUninitialized())

Uint32 propDeclPos = indicationClass.findProperty(prop.getName());

if (propDeclPos != PEG_NOT_FOUND)

{

CIMName propName = prop.getName();

CIMProperty propDecl = indicationClass.getProperty(propDeclPos);

Uint32 propPos = indicationClass.findProperty(propName);

if (propPos != PEG_NOT_FOUND)

{

CIMProperty trapProp = indicationClass.getProperty(propPos);

qualifierPos = trapProp.findQualifier(CIMName ("MappingStrings"));

Uint32 qualifierPos =

propDecl.findQualifier(CIMName("MappingStrings"));

if (qualifierPos != PEG_NOT_FOUND)

{

trapQualifier = trapProp.getQualifier(qualifierPos);

// We are looking for following fields:

// MappingStrings {"OID.IETF | SNMP." oidStr,

// "DataType.IETF |" dataType}

// oidStr is the object identifier (e.g. "1.3.6.1.2.1.5..."

// dataType is either Integer, or OctetString,

// or OID

// Following is one example:

// MappingStrings {"OID.IETF | SNMP.1.3.6.6.3.1.1.5.2",

// "DataType.IETF | Integer"}

mapstr1.clear();

propDecl.getQualifier(qualifierPos).getValue().get(

mapstr1 = trapQualifier.getValue().toString();

mapStr);

if ((mapstr1.find("OID.IETF") != PEG_NOT_FOUND) &&

String oidStr, dataType;

(mapstr1.find("DataType.IETF") != PEG_NOT_FOUND))

String mapStr1, mapStr2;

{

Boolean isValidAuthority = false;

if (mapstr1.subString(0, 8) == "OID.IETF")

Boolean isValidDataType = false;

for (Uint32 j=0; j < mapStr.size(); j++)

{

mapstr1 = mapstr1.subString(mapstr1.find("SNMP.")+5);

Uint32 barPos = mapStr[j].find("|");

if (mapstr1.find("|") != PEG_NOT_FOUND)

if (barPos != PEG_NOT_FOUND)

{

mapstr2.clear();

mapStr1 = mapStr[j].subString(0, barPos);

mapstr2 = mapstr1.subString(0,

mapStr2 = mapStr[j].subString(barPos + 1);

mapstr1.find("DataType.IETF")-1);

propOIDs.append(mapstr2);

propValue.clear();

_trimWhitespace(mapStr1);

propValue = prop.getValue().toString();

_trimWhitespace(mapStr2);

propVALUEs.append(propValue);

mapstr2 = mapstr1.subString(mapstr1.find("|")+2);

if ((mapStr1 == "OID.IETF") &&

mapstr2 = mapstr2.subString(0, mapstr2.size()-1);

(String::compare(mapStr2,

propTYPEs.append(mapstr2);

String("SNMP."), 5) == 0))

{

isValidAuthority = true;

oidStr = mapStr2.subString(5);

}

else if (mapStr1 == "DataType.IETF")

{

isValidDataType = true;

dataType = mapStr2;

}

if (isValidAuthority && isValidDataType)

{

propOIDs.append(oidStr);

propTYPEs.append(dataType);

propVALUEs.append(prop.getValue().toString());

break;

}

Line 134

Line 208

// trap destination and SNMP type are defined in handlerInstance

// and passing this instance as it is to deliverTrap() call

#ifdef HPUX_EMANATE

snmpDeliverTrap_emanate emanateTrap;

#else

snmpDeliverTrap_stub emanateTrap;

#endif

Uint32 targetHostPos = handler.findProperty(CIMName ("TargetHost"));

Uint32 targetHostFormatPos = handler.findProperty(CIMName ("TargetHostFormat"));

Uint32 targetHostFormatPos =

Uint32 otherTargetHostFormatPos = handler.findProperty(CIMName (

handler.findProperty(CIMName("TargetHostFormat"));

"OtherTargetHostFormat"));

Uint32 otherTargetHostFormatPos =

handler.findProperty(CIMName("OtherTargetHostFormat"));

Uint32 portNumberPos = handler.findProperty(CIMName ("PortNumber"));

Uint32 snmpVersionPos = handler.findProperty(CIMName ("SNMPVersion"));

Uint32 securityNamePos = handler.findProperty(CIMName ("SNMPSecurityName"));

Uint32 securityNamePos =

handler.findProperty(CIMName("SNMPSecurityName"));

Uint32 engineIDPos = handler.findProperty(CIMName ("SNMPEngineID"));

Uint32 snmpSecLevelPos =

if ((targetHostPos != PEG_NOT_FOUND) &&

handler.findProperty(CIMName("SNMPSecurityLevel"));

(targetHostFormatPos != PEG_NOT_FOUND) &&

Uint32 snmpSecAuthProtoPos =

(snmpVersionPos != PEG_NOT_FOUND) &&

handler.findProperty(CIMName("SNMPSecurityAuthProtocol"));

(indicationClass.findQualifier(CIMName ("MappingStrings")) !=

Uint32 snmpSecAuthKeyPos =

PEG_NOT_FOUND))

handler.findProperty(CIMName("SNMPSecurityAuthKey"));

Uint32 snmpSecPrivProtoPos =

handler.findProperty(CIMName("SNMPSecurityPrivProtocol"));

Uint32 snmpSecPrivKeyPos =

handler.findProperty(CIMName("SNMPSecurityPrivKey"));

if (targetHostPos == PEG_NOT_FOUND)

{

PEG_TRACE((TRC_DISCARDED_DATA, Tracer::LEVEL1,

"Target host is not set for IndicationHandlerSNMPMapper %s"

" Indication.",

(const char*)(indication.getClassName().getString().

getCString())));

PEG_METHOD_EXIT();

throw PEGASUS_CIM_EXCEPTION_L(CIM_ERR_FAILED, MessageLoaderParms(

"Handler.snmpIndicationHandler.snmpIndicationHandler."

"INVALID_SNMP_INSTANCE",

"Invalid IndicationHandlerSNMPMapper instance"));

}

if (targetHostFormatPos == PEG_NOT_FOUND)

{

PEG_TRACE((TRC_DISCARDED_DATA, Tracer::LEVEL1,

"Target host format is not set for IndicationHandlerSNMPMapper"

" %s Indication.",

(const char*)(indication.getClassName().getString().

getCString())));

PEG_METHOD_EXIT();

throw PEGASUS_CIM_EXCEPTION_L(CIM_ERR_FAILED, MessageLoaderParms(

"Handler.snmpIndicationHandler.snmpIndicationHandler."

"INVALID_SNMP_INSTANCE",

"Invalid IndicationHandlerSNMPMapper instance"));

}

if (snmpVersionPos == PEG_NOT_FOUND)

{

PEG_TRACE((TRC_DISCARDED_DATA, Tracer::LEVEL1,

"SNMP Version is not set for IndicationHandlerSNMPMapper %s"

" Indication.",

(const char*)(indication.getClassName().getString().

getCString())));

PEG_METHOD_EXIT();

throw PEGASUS_CIM_EXCEPTION_L(CIM_ERR_FAILED, MessageLoaderParms(

"Handler.snmpIndicationHandler.snmpIndicationHandler."

"INVALID_SNMP_INSTANCE",

"Invalid IndicationHandlerSNMPMapper instance"));

}

else

{

// properties from the handler instance

String targetHost, otherTargetHostFormat;

String targetHost;

String securityName, engineID;

String otherTargetHostFormat = String();

Uint16 targetHostFormat, snmpVersion;

String securityName = String();

String engineID = String();

Uint16 targetHostFormat = 0;

Uint16 snmpVersion = 0;

Uint32 portNumber;

Uint8 snmpSecLevel = 1; // noAuthnoPriv

Uint8 snmpSecAuthProto = 0;

Array<Uint8> snmpSecAuthKey;// no key

Uint8 snmpSecPrivProto = 0;

Array<Uint8> snmpSecPrivKey ;// no key

String trapOid;

Boolean trapOidAvailable = false;

// Get snmpTrapOid from context

try

if (context.contains(SnmpTrapOidContainer::NAME))

{

SnmpTrapOidContainer trapContainer = context.get

SnmpTrapOidContainer trapContainer =

(SnmpTrapOidContainer::NAME);

context.get(SnmpTrapOidContainer::NAME);

trapOid = trapContainer.getSnmpTrapOid();

trapOidAvailable = true;

}

catch (Exception& e)

else

{

// get trapOid from indication Class

Uint32 pos = indicationClass.findQualifier(CIMName ("MappingStrings"));

Uint32 pos =

indicationClass.findQualifier(CIMName("MappingStrings"));

if (pos != PEG_NOT_FOUND)

{

trapOid = indicationClass.getQualifier(pos).getValue().toString();

Array<String> classMapStr;

indicationClass.getQualifier(pos).getValue().

get(classMapStr);

trapOid = trapOid.subString(11, PEG_NOT_FOUND);

for (Uint32 i=0; i < classMapStr.size(); i++)

{

Uint32 barPos = classMapStr[i].find("|");

if ((String::compare(trapOid, "SNMP.", 5)) == 0)

if (barPos != PEG_NOT_FOUND)

{

trapOid = trapOid.subString(5, (trapOid.size()-6));

String authorityName =

classMapStr[i].subString(0, barPos);

String oidStr = classMapStr[i].subString(

barPos+1, PEG_NOT_FOUND);

_trimWhitespace(authorityName);

_trimWhitespace(oidStr);

if ((authorityName == "OID.IETF") &&

(String::compare(oidStr,

String("SNMP."), 5) == 0))

{

trapOid = oidStr.subString(5);

trapOidAvailable = true;

break;

}

else

}

if (!trapOidAvailable)

{

// l10n

PEG_TRACE((

// throw PEGASUS_CIM_EXCEPTION(CIM_ERR_FAILED, "Invalid MappingStrings Value");

TRC_IND_HANDLER,

throw PEGASUS_CIM_EXCEPTION_L (CIM_ERR_FAILED,

Tracer::LEVEL1,

MessageLoaderParms("Handler.snmpIndicationHandler.snmpIndicationHandler.INVALID_VALUE",

"No MappingStrings for snmp trap is specified "

"Invalid $0 Value", "MappingStrings"));

"for class: %s",

(const char*)

indication.getClassName().getString().getCString()

));

PEG_METHOD_EXIT();

throw PEGASUS_CIM_EXCEPTION_L(

CIM_ERR_FAILED,

MessageLoaderParms(

"Handler.snmpIndicationHandler."

"snmpIndicationHandler.NO_MS_FOR_SNMP_TRAP",

"No MappingStrings for snmp trap is specified "

"for class: $0",

indication.getClassName().getString()));

}

else

{

//L10N_TODO

PEG_TRACE_CSTRING(TRC_IND_HANDLER, Tracer::LEVEL1,

throw PEGASUS_CIM_EXCEPTION(CIM_ERR_FAILED, "Qualifier MappingStrings can not be found");

"Qualifier MappingStrings can not be found.");

PEG_METHOD_EXIT();

MessageLoaderParms parms(

"Handler.snmpIndicationHandler.snmpIndicationHandler."

"QUALIFIER_MAPPINGS_NOT_FOUND",

"Qualifier MappingStrings can not be found");

throw PEGASUS_CIM_EXCEPTION_L(CIM_ERR_FAILED, parms);

}

handler.getProperty(targetHostPos).getValue().get(targetHost);

handler.getProperty(targetHostFormatPos).getValue().get(targetHostFormat);

handler.getProperty(targetHostFormatPos).getValue().get(

handler.getProperty(otherTargetHostFormatPos).getValue().get

targetHostFormat);

(otherTargetHostFormat);

if (otherTargetHostFormatPos != PEG_NOT_FOUND)

{

handler.getProperty(otherTargetHostFormatPos).getValue().get(

otherTargetHostFormat);

}

if (portNumberPos != PEG_NOT_FOUND)

{

handler.getProperty(portNumberPos).getValue().get(portNumber);

}

else

{

// default port

portNumber = SNMP_TRAP_DEFAULT_PORT;

}

handler.getProperty(snmpVersionPos).getValue().get(snmpVersion);

handler.getProperty(securityNamePos).getValue().get(securityName);

if (securityNamePos != PEG_NOT_FOUND)

{

handler.getProperty(securityNamePos).getValue().get(

securityName);

}

if (engineIDPos != PEG_NOT_FOUND)

{

handler.getProperty(engineIDPos).getValue().get(engineID);

}

if(snmpVersion == 5) // SNMPv3 Trap

{

//fetch the security data

if(snmpSecLevelPos != PEG_NOT_FOUND)

{

handler.getProperty(snmpSecLevelPos).getValue(). \

get(snmpSecLevel);

}

if(snmpSecAuthProtoPos != PEG_NOT_FOUND)

{

handler.getProperty(snmpSecAuthProtoPos).getValue(). \

get(snmpSecAuthProto);

}

if(snmpSecAuthKeyPos != PEG_NOT_FOUND)

{

handler.getProperty(snmpSecAuthKeyPos).getValue(). \

get(snmpSecAuthKey);

}

if(snmpSecPrivProtoPos != PEG_NOT_FOUND)

{

handler.getProperty(snmpSecPrivProtoPos).getValue(). \

get(snmpSecPrivProto);

}

if(snmpSecPrivKeyPos!= PEG_NOT_FOUND)

{

handler.getProperty(snmpSecPrivKeyPos).getValue(). \

get(snmpSecPrivKey);

}

emanateTrap.deliverTrap(

PEG_TRACE ((TRC_INDICATION_GENERATION, Tracer::LEVEL4,

"snmpIndicationHandler sending %s Indication trap %s to target"

" host %s target port %d",

(const char*)(indication.getClassName().getString().

getCString()),

(const char*)(trapOid.getCString()),

(const char*)(targetHost.getCString()),portNumber));

_snmpTrapSender->deliverTrap(

trapOid,

securityName,

targetHost,

Line 221

Line 445

portNumber,

snmpVersion,

engineID,

snmpSecLevel,

snmpSecAuthProto,

snmpSecAuthKey,

snmpSecPrivProto,

snmpSecPrivKey,

propOIDs,

propTYPEs,

propVALUEs);

PEG_TRACE ((TRC_INDICATION_GENERATION, Tracer::LEVEL4,

"%s Indication trap %s sent to target host %s target port %d "

"successfully",

(const char*)(indication.getClassName().getString().getCString()),

(const char*)(trapOid.getCString()),

(const char*)(targetHost.getCString()),portNumber));

}

else

}

catch (CIMException& c)

{

PEG_TRACE((TRC_IND_HANDLER, Tracer::LEVEL1, "CIMException %s",

(const char*)c.getMessage().getCString()));

PEG_METHOD_EXIT();

throw PEGASUS_CIM_EXCEPTION(CIM_ERR_FAILED, c.getMessage());

}

catch (Exception& e)

{

// l10n

PEG_TRACE((TRC_IND_HANDLER, Tracer::LEVEL1, "Exception %s",

(const char*)e.getMessage().getCString()));

PEG_METHOD_EXIT();

// throw PEGASUS_CIM_EXCEPTION(CIM_ERR_FAILED,

throw PEGASUS_CIM_EXCEPTION(CIM_ERR_FAILED, e.getMessage());

// "Invalid IndicationHandlerSNMPMapper instance");

}

catch (...)

{

PEG_TRACE_CSTRING(TRC_IND_HANDLER, Tracer::LEVEL1,

"Failed to deliver trap.");

PEG_METHOD_EXIT();

throw PEGASUS_CIM_EXCEPTION_L (CIM_ERR_FAILED,

throw PEGASUS_CIM_EXCEPTION_L(CIM_ERR_FAILED, MessageLoaderParms(

MessageLoaderParms("Handler.snmpIndicationHandler.snmpIndicationHandler.INVALID_INSTANCE",

"Handler.snmpIndicationHandler.snmpIndicationHandler."

"Invalid $0 instance", "IndicationHandlerSNMPMapper"));

"FAILED_TO_DELIVER_TRAP",

"Failed to deliver trap."));

}

PEG_METHOD_EXIT();

}

// This is the dynamic entry point into this dynamic module. The name of

void snmpIndicationHandler::_trimWhitespace(

// this handler is "snmpIndicationHandler" which is appended to "PegasusCreateHandler_"

String & nameStr)

// to form a symbol name. This function is called by the HandlerTable

{

// to load this handler.

PEG_METHOD_ENTER(TRC_IND_HANDLER,

"snmpIndicationHandler::_trimWhitespace");

extern "C" PEGASUS_EXPORT CIMHandler*

Uint32 ps = 0;

PegasusCreateHandler_snmpIndicationHandler() {

// skip begining whitespace

return new snmpIndicationHandler;

for (ps = 0; ps < nameStr.size(); ps++)

{

if (nameStr[ps] != ' ')

{

break;

}

if (ps != 0)

{

nameStr.remove(0, ps);

}

// skip the appended whitespace

for (ps = nameStr.size(); ps != 0; ps--)

{

if (nameStr[ps-1] != ' ')

{

break;

}

if (ps != nameStr.size())

{

nameStr.remove(ps);

}

PEG_METHOD_EXIT();

}

PEGASUS_NAMESPACE_END

PEGASUS_USING_PEGASUS;

// This is the entry point into this dynamic module.

extern "C" PEGASUS_EXPORT CIMHandler* PegasusCreateHandler(

const String& handlerName)

{

if (handlerName == "snmpIndicationHandler")

{

return new snmpIndicationHandler;

}

return 0;

}

Legend:

Removed from v.1.16
changed lines
	Added in v.1.46

No CVS admin address has been configured