|
|
/*++ BUILD Version: 0001 // Increment this if a change has global effects
Copyright (c) 1991 Microsoft Corporation
Module Name:
main.c
Abstract:
SNMP Extension Agent for SMTP Service on Windows NT.
Created:
MuraliK 22-Feb-1995
Revision History:
--*/
#include "mib.h"
#include <excpt.h>
#include "smtptype.h"
#include "smtpapi.h"
#include <apiutil.h>
#include <dbgutil.h>
#define LowDword( x ) ( *((LPDWORD)&(x)) )
#define HighDword( x ) ( *((LPDWORD)&(x)+1) )
/************************************************************
* Variable Definitions ************************************************************/
//
// Definition of the MIB objects
//
//
// The InternetServer section of the OID tree is organized as follows:
//
// iso(1)
// org(3)
// dod(6)
// internet(1)
// private(4)
// enterprises(1)
// microsoft(311)
// software(1)
// InternetServer(7)
// InetSrvCommon(1)
// InetSrvStatistics(1)
// FtpServer(2)
// FtpStatistics(1)
// HttpServer(3)
// HttpStatistics(1)
// GopherServer(4)
// GopherStatistics(1)
// MnsServer(5)
// MsnStatistics(1)
// NntpServer(6)
// NntpStatistics(1)
// SmtpServer(7)
// SmtpStatistics(1)
//
static UINT sg_rguiPrefix[] = { 1, 3, 6, 1, 4, 1, 311, 1, 7, 7};static AsnObjectIdentifier sg_MibOidPrefix = OID_FROM_UINT_ARRAY( sg_rguiPrefix);
# define SMTP_PREFIX_OID_LENGTH ( GET_OID_LENGTH( sg_MibOidPrefix))
# define SMTP_STATISTICS_OID_SUFFIX ( 1)
//
// Following is the global description of all MIB Entries ( Mibe s) for
// Smtp Service.
// Definition appears as:
// Mibe( MIB Entry Name, Index in MIB Block, SmtpStatisticsField)
//
// Incidentally, MIB Entry suffix coincides with the entry name in OID Tree
//
// Any New MIB should be added here. and dont change use of after this defn.
//
// HighWord need to be treated special to account for int64 to 32 bit quantities
//
# define ALL_MIB_ENTRIES() \
MibH( BytesSentTotal_HighWord, 1, BytesSentTotal) \Mibe( BytesSentTotal_LowWord, 2, BytesSentTotal) \MibH( BytesRcvdTotal_HighWord, 3, BytesRcvdTotal) \Mibe( BytesRcvdTotal_LowWord, 4, BytesRcvdTotal) \MibH( BytesSentMsg_HighWord, 5, BytesSentMsg) \Mibe( BytesSentMsg_LowWord, 6, BytesSentMsg) \MibH( BytesRcvdMsg_HighWord, 7, BytesRcvdMsg) \Mibe( BytesRcvdMsg_LowWord, 8, BytesRcvdMsg) \Mibe( NumMsgRecvd, 9, NumMsgRecvd) \Mibe( NumRcptsRecvd, 10, NumRcptsRecvd) \Mibe( NumRcptsRecvdLocal, 11, NumRcptsRecvdLocal) \Mibe( NumRcptsRecvdRemote, 12, NumRcptsRecvdRemote) \Mibe( MsgsRefusedDueToSize, 13, MsgsRefusedDueToSize) \Mibe( MsgsRefusedDueToNoCAddrObjects, 14, MsgsRefusedDueToNoCAddrObjects) \Mibe( MsgsRefusedDueToNoMailObjects, 15, MsgsRefusedDueToNoMailObjects) \Mibe( NumMsgsDelivered, 16, NumMsgsDelivered) \Mibe( NumDeliveryRetries, 17, NumDeliveryRetries) \Mibe( NumMsgsPickedUp, 18, NumMsgsForwarded) \Mibe( NumNDRGenerated, 19, NumNDRGenerated) \Mibe( LocalQueueLength, 20, LocalQueueLength) \Mibe( LocalRetryQueueLength, 21, RetryQueueLength) \Mibe( NumMailFileHandles, 22, NumMailFileHandles) \Mibe( NumQueueFileHandles, 23, NumQueueFileHandles) \Mibe( NumMsgsSent, 24, NumMsgsSent) \Mibe( NumRcptsSent, 25, NumRcptsSent) \Mibe( NumSendRetries, 26, NumSendRetries) \Mibe( RemoteQueueLength, 27, RemoteQueueLength) \Mibe( NumDnsQueries, 28, NumDnsQueries) \Mibe( RemoteRetryQueueLength, 29, RemoteRetryQueueLength) \Mibe( NumConnInOpen, 30, NumConnInOpen) \Mibe( NumConnInClose, 31, NumConnInClose) \Mibe( NumConnOutOpen, 32, NumConnOutOpen) \Mibe( NumConnOutClose, 33, NumConnOutClose) \Mibe( NumConnOutRefused, 34, NumConnOutRefused) \Mibe( NumProtocolErrs, 35, NumProtocolErrs) \Mibe( DirectoryDrops, 36, DirectoryDrops) \Mibe( RoutingTableLookups, 37, RoutingTableLookups) \Mibe( ETRNMessages, 38, ETRNMessages)
//
// Individual OID Definitions.
// All Leaf variables should have a zero appended to their OID to indicate
// that it is the only instance of this variable and that it exists.
// Declare just the id's starting from next to the prefix given above.
//
//
// Few Convenience Macros for MIB entries addition.
//
# define MIB_VAR_NAME( NameSuffix) MIB_ ## NameSuffix
# define DEFINE_MIBOID( NameSuffix, uiArray) \
UINT MIB_VAR_NAME( NameSuffix)[] = uiArray
# define DEFINE_MIBOID_LEAF( NameSuffix, NodeNumber) \
UINT MIB_VAR_NAME( NameSuffix)[] = \ { SMTP_STATISTICS_OID_SUFFIX, ( NodeNumber), 0 }
//
// Define all the OIDs. First define the higher level node and then leaves.
//
DEFINE_MIBOID( Statistics, { SMTP_STATISTICS_OID_SUFFIX} );
//
// Define the Leaf OIDs.
//
# define Mibe( NameSuffix, Index, FieldName) \
DEFINE_MIBOID_LEAF( NameSuffix, Index);
#define MibH( NameSuffix, Index, FieldName) \
Mibe( NameSuffix, Index, FieldName)
//
// Expand the macro ALL_MIB_ENTRIES to obtain definitions of MIB Leafs.
//
ALL_MIB_ENTRIES()
# undef Mibe
# undef MibH
//
// MIB Variable definition
//
//
// Define Mibe() to be for variable definitions of counters.
// Note that the comma is appearing before a new counter name. It is used
// for structure initialization.
//
# define OFFSET_IN_SMTP_STATISTICS( Field) \
FIELD_OFFSET( SMTP_STATISTICS_0, Field)
# define Mibe( NameSuffix, Index, Field) \
, MIB_COUNTER( OID_FROM_UINT_ARRAY( MIB_VAR_NAME( NameSuffix)), \ OFFSET_IN_SMTP_STATISTICS(Field), \ MibStatisticsWorker)
# define MibH( NameSuffix, Index, Field) \
, MIB_COUNTER( OID_FROM_UINT_ARRAY( MIB_VAR_NAME( NameSuffix)), \ OFFSET_IN_SMTP_STATISTICS(Field) + sizeof(DWORD), \ MibStatisticsWorker)
static MIB_ENTRY sg_rgSmtpMib[] = {
//
// Statistics
//
MIB_ENTRY_HEADER( OID_FROM_UINT_ARRAY( MIB_VAR_NAME( Statistics))) ALL_MIB_ENTRIES()};
# undef Mibe
# undef MibH
static MIB_ENTRIES sg_SmtpMibs = { &sg_MibOidPrefix, ( sizeof( sg_rgSmtpMib) / sizeof( MIB_ENTRY)), sg_rgSmtpMib };
/************************************************************
* Functions ************************************************************/
BOOL WINAPIDllLibMain( IN HINSTANCE hinstDll, IN DWORD fdwReason, IN LPVOID lpvContext OPTIONAL)/*++
Routine Description:
This function DllLibMain() is the main initialization function for Smtp MIB DLL. It initialises local variables and prepares the interface for the process to use SNMP Extension Agents for SMTP service.
Messages Actions
ProcessAttach Initializes winsock and data structures. It fails if winsock has not already been started.
ProcessDetach Cleans up local data structures and disconnects from winsock.
Arguments:
hinstDll Instance Handle of the DLL fdwReason Reason why NT called this DLL lpvReserved Reserved parameter for future use.
Return Value:
Returns TRUE is successful; otherwise FALSE is returned.
--*/{ BOOL fReturn = TRUE;
switch (fdwReason ) {
case DLL_PROCESS_ATTACH: {
//
// Initialize various modules
//
break; } /* case DLL_PROCESS_ATTACH */
case DLL_PROCESS_DETACH: {
//
// Only cleanup when we are called because of a FreeLibrary().
// i.e., when lpvContext == NULL
// If we are called because of a process termination, dont free anything
// the system will free resources and memory for us.
//
if ( lpvContext == NULL) {
//
// Code to be executed on successful termination
//
}
break; } /* case DLL_PROCESS_DETACH */
default: break; } /* switch */
return ( fReturn);} /* DllLibMain() */
/************************************************************
* Entry Points of SNMP Extension DLL For Smtp Service ************************************************************/
//
// Extension Agent DLLs need access to elapsed time agent has been active.
// This is implemented by initializing the Extension Agent with a time zero
// reference, and allowing the agent to compute elapsed time by subtracting
// the time zero reference from the current system time. This example
// Extension Agent implements this reference with dwTimeZero.
//
DWORD dwTimeZero = 0;
BOOLSnmpExtensionInit( IN DWORD dwTimeZeroReference, OUT HANDLE * phPollForTrapEvent, OUT AsnObjectIdentifier * pAsnOidSupportedView )/*++
Description: The Extension Agent DLLs provide this entry point SnmpExtensionInit() to co-ordinate the initializations of the extension agent and the extendible agent. The Extendible agent provides extension agent with a time zero reference. The Extension Agent provides Extendible agent with an Event Handle for communicating occurences of traps. The Extension Agent also provides Extendible agent with an ObjectId representing the root of the MIB structure that it (extension) supports.
Arguments: dwTimeZeroReference DWORD containing the Time Zero Reference for sync. phPollForTrapEvent pointer to handle which on successful return may contain an event handle to be polled for traps. pAsnOidSupportedView pointer to ASN ( Abstract Syntax Notation OID) that contains the oid representing root of the MIB structure.
Returns: TRUE on success and FALSE if there is any failure.--*/{
//
// Record the time reference provided by the Extendible Agent.
//
dwTimeZero = dwTimeZeroReference;
//
// Indicate the MIB view supported by this Extension Agent, an object
// identifier representing the sub root of the MIB that is supported.
//
*pAsnOidSupportedView = sg_MibOidPrefix; // NOTE! structure copy
//
// Though the following is a handle, dont use INVALID_HANDLE_VALUE ( -1)
// because that constant is only for few people ( Win32). But all through
// NT invalid handle value is NULL ( 0).
//
*phPollForTrapEvent = NULL;
//
// Indicate that Extension Agent initialization was sucessfull.
//
return ( TRUE);
} // SnmpExtensionInit()
BOOLSnmpExtensionTrap( OUT AsnObjectIdentifier * pAsnOidEnterprise, OUT AsnInteger * pAsniGenericTrap, OUT AsnInteger * pAsniSpecificTrap, OUT AsnTimeticks * pAsnTimeStamp, OUT RFC1157VarBindList * pRfcVariableBindings )/*++
Description: This function is used to communicate traps to the Extendible Agent. The Extendible Agent will invoke this entry point when the trap event ( supplied at the initialization time) is asserted, which indicates that zero or more traps had occured. The Extendible agent will repeatedly query this function till this function returns FALSE.
Arguments: pAsnOidEnterprise pointer to ASN OID for Enterprise, indicating original enterprise generating trap. pAsniGenericTrap pointer to ASN Integer which on return will contain the indication of the generic trap. pAsniSpecificTrap pointer to ASN Integer which on return will contain the specific trap generated. pAsnTimeStamp pointer to ASN containing the received Time-Stamp. pRfcVariableBindings pointer to RFC 1157 compliant variable bindings.
Returns: TRUE if success and there are more traps to be queried. FALSE if all traps are answered and work done.
--*/{
//
// We don't support traps (yet).
//
return ( FALSE);
} // SnmpExtensionTrap()
BOOLSnmpExtensionQuery( IN BYTE bRequestType, IN OUT RFC1157VarBindList * pRfcVariableBindings, OUT AsnInteger * pAsniErrorStatus, OUT AsnInteger * pAsniErrorIndex )/*++
Description: This function is called by Extendible Agent to resolve the SNMP requests for queries on MIB Variables in the Extension Agent's supported MIB view. ( which was supplied at initialization time). The Request Type is GET, GETNEXT, and SET.
Arguments: bRequestType byte containing the type of request. It can be one of ASN_RFC1157_GETREQUEST ASN_RFC1157_GETNEXTREQUEST ASN_RFC1157_SETREQUEST
pRfcVariableBindings pointer to RFC 1157 compliant variable bindings.
pAsniErrorStatus pointer to ASN Integer for Error Status
pAsniErrorIndex pointer to ASN INteger giving the index for error.
Returns: TRUE on success and FALSE on failure.--*/
{ LPSMTP_STATISTICS_0 pSmtpStatistics = NULL; NET_API_STATUS Status; PSMTP_STATISTICS_BLOCK_ARRAY aStatsBlockArray = NULL;
//
// Try to query the statistics now so we'll have a consitent
// view across all variable bindings.
//
Status = SmtpQueryStatistics( NULL, // pszServer
0, (LPBYTE *) &aStatsBlockArray );
if (aStatsBlockArray != NULL) { //
// **** RETURN STATISTICS FOR THE FIRST INSTANCE ONLY !! ****
//
pSmtpStatistics = &(aStatsBlockArray->aStatsBlock->Stats_0); } else { // if SmtpQueryStatistics fails, we should bail out here
return ( SNMPAPI_ERROR); }
//
// Status Errors not checked for here!
// Reason:
// If the verb is GET_NEXT beyond the block we support,
// then there is no need to worry about the error at all.
// If the verb is GET within the block, it will get NULL value
// ( due the memset() done above).
//
__try {
//
// Iterate through the variable bindings list to resolve individual
// variable bindings.
//
RFC1157VarBind * pVarBinding;
for( pVarBinding = pRfcVariableBindings->list; pVarBinding < ( pRfcVariableBindings->list + pRfcVariableBindings->len); pVarBinding++ ) {
*pAsniErrorStatus = ResolveVarBinding( pVarBinding, bRequestType, pSmtpStatistics, &sg_SmtpMibs);
//
// Test and handle case where Get Next past end of MIB view
// supported by this Extension Agent occurs. Special
// processing is required to communicate this situation to
// the Extendible Agent so it can take appropriate action,
// possibly querying other Extension Agents.
//
if(( *pAsniErrorStatus == SNMP_ERRORSTATUS_NOSUCHNAME ) && ( bRequestType == MIB_GETNEXT ) ) {
*pAsniErrorStatus = SNMP_ERRORSTATUS_NOERROR;
//
// Modify variable binding of such variables so the OID
// points just outside the MIB view supported by this
// Extension Agent. The Extendible Agent tests for this,
// and takes appropriate action.
//
SNMP_oidfree( &pVarBinding->name ); SNMP_oidcpy( &pVarBinding->name, &sg_MibOidPrefix); pVarBinding->name.ids[ SMTP_PREFIX_OID_LENGTH - 1]++; }
//
// If an error was indicated, communicate error status and error
// index to the Extendible Agent. The Extendible Agent will
// ensure that the origional variable bindings are returned in
// the response packet.
*pAsniErrorIndex = (( *pAsniErrorStatus != SNMP_ERRORSTATUS_NOERROR ) ? ((size_t)( pVarBinding - pRfcVariableBindings->list) + 1) : 0);
} // for
} __except( EXCEPTION_EXECUTE_HANDLER ) {
//
// For now do nothing.
//
}
if ( aStatsBlockArray ) { NetApiBufferFree( aStatsBlockArray ); }
return ( SNMPAPI_NOERROR);
} // SnmpExtensionQuery()
|
