saf-esm.h

Go to the documentation of this file.

/****************************************************************************
 *
 * Copyright (C) 2006-2007 Micro Focus (IP) Limited.
 * All rights reserved.
 *
 * The software and information contained herein are proprietary to, and
 * comprise valuable trade secrets of, Micro Focus International Ltd., 
 * which intends to preserve as trade secrets such software and 
 * information. This software is an unpublished copyright of Micro Focus  
 * and may not be used, copied, transmitted, or stored in any manner.  
 * This software and information or any other copies thereof may not be
 * provided or otherwise made available to any other person.
 *
 *      Enterprise Server SAF (Security) Manager
 *      ESM Loader and Interface
 *
 *      @(#)saf-esm.h   $Revision: 1.8 $     
 *
 *      $Date: 2009/04/07 14:56:53 $
 *
 ****************************************************************************/

/* Start of source module saf-esm.h */
#if !defined(SafESM_H)
#define SafESM_H

/* Declare structures defined elsewhere */
struct SafInit;
struct SafACEE;
struct safpb_parameter_block;
struct SafStore;


/* ESM Module Interface */

/*** Utility API for ESM Modules ***/

struct SafEsmApi
{
   mf_uns32    VerMajor; 
   #define     SafESM_API_VER_MAJ 1 
   mf_uns32    VerMinor; 
   #define     SafESM_API_VER_MIN 3 
   mf_uns32    Count;    
   mf_uns32    (*Log)(mf_uns32 Number, mf_uns32 Level, const char *Text,
                      mf_uns32 Length, void *Reserved);

   mf_uns32    (*GetAcee)(const char *Name, const char *Group,
                          struct SafACEE **AceePtr, mf_uns32 *Info,
                          void *Reserved);

   mf_uns32    (*GetSharedMem)(const char *Name, mf_uns32 *SizePtr,
                               void **MemPtr, void *Reserved);

   mf_uns32    (*LockEnq)(const char *QName, const char *RName,
                          mf_uns32 RNameLen, void *Reserved);

   mf_uns32    (*LockDeq)(const char *QName, const char *RName,
                          mf_uns32 RNameLen, void *Reserved);

   mf_uns32    (*GetSafInit)(struct SafInit **InitPtr, void *Reserved);

   mf_uns32    (*ExtractVerifyStrings)(struct safpb_parameter_block *Request,
                                       char *UserBuf,  mf_uns32 UserMax,
                                       char *PassBuf,  mf_uns32 PassMax,
                                       char *NPassBuf, mf_uns32 NPassMax,
                                       char *GroupBuf, mf_uns32 GroupMax,
                                       void *Reserved);

   mf_uns32    (*ExtractAuthStrings)(struct safpb_parameter_block *Request,
                                     char *ClassBuf,    mf_uns32 ClassMax,
                                     char *EntityBuf,   mf_uns32 EntityMax,
                                     char *FacilityBuf, mf_uns32 FacilityMax,
                                     char *TransBuf,    mf_uns32 TransMax,
                                     void *Reserved);

   int         (*CasMessage)();

   int         (*CasService)();

   int         (*CasLockMgr)();

   mf_uns32    (*ExtractXAuthStrings)(struct safpb_parameter_block *Request,
                                      char *ClassBuf,    mf_uns32 ClassMax,
                                      char *EntityBuf,   mf_uns32 EntityMax,
                                      char *FacilityBuf, mf_uns32 FacilityMax,
                                      char *TransBuf,    mf_uns32 TransMax,
                                      void *Reserved);

   mf_uns32    (*SafQuery)(mf_uns32 Type, void *Result, mf_uns32 ResSize,
                           void *Reserved);

   mf_uns32    (*ParseConfig)(const char *Text, struct SafStore **Result,
                              void *Reserved);

   mf_uns32    (*QueryConfig)(struct SafStore *Config,
                              const char *Class, const char *Name,
                              char **Value, void *Reserved);

   mf_uns32    (*FreeConfig)(struct SafStore *Config, void *Reserved);

   mf_uns32    (*AceeIterate)(void *Data,
                              int (*Callback)(struct SafACEE *, void *),
                              void *Reserved);
};


#define SafQUERY_MT     1  
#define SafQUERY_ALLGRP 2  



/*** Interface into ESM Modules ***/


struct SafPTab
{
   mf_uns32     Version; 
   #define      SafESM_PT_VER  1       
   mf_uns32     (*Init)(const mf_uns32 *Index,
                        struct cas_esm_config_internal *Config,
                        const struct SafEsmApi *Api, void *Reserved);

   mf_uns32     (*Info)(const char **Name, mf_uns32 *IFVersion,
                        const unsigned char **Signature, void *Reserved);
   #define      SafESM_IF_VER  1       
   mf_uns32     (*Verify)(struct safpb_parameter_block *Request,
                          void *Reserved);

   mf_uns32     (*Auth)(struct safpb_parameter_block *Request, void *Reserved);

   mf_uns32     (*XAuth)(struct safpb_parameter_block *Request, void *Reserved);

   mf_uns32     (*Update)(mf_s32 Type, struct safpb_parameter_block *Request,
                          void *Reserved);
   #define      SafESM_UPDATE  0       
   #define      SafESM_UPDATED 1       
   #define      SafESM_REFRESH 2       


   mf_uns32     (*Status)();

   mf_uns32     (*Control)();

   mf_uns32     (*Exit)(const mf_uns32 *Index, void *Reserved);

   mf_uns32     (*Admin)(struct safpb_parameter_block *Request,
                         void *Reserved);

   mf_uns32     (*Reserved)();
};


#define SafESMRC_OK          0   
#define SafESMRC_NOTIMPL     1   
#define SafESMRC_PARAM       2   
#define SafESMRC_RESOURCE    3   
#define SafESMRC_EXTERNAL    4   
#define SafESMRC_MGRFAIL     5   
#define SafESMRC_FAIL      100   



/*** ESM Loader Interface ***/

mf_uns32 SafEsmInit(struct SafInit *Init);
mf_uns32 SafEsmExit(void);
mf_uns32 SafEsmUnload(void);

mf_uns32 SafEsmEnable(mf_uns32 Index);
mf_uns32 SafEsmDisable(mf_uns32 Index);

const char *SafEsmName(mf_uns32 Index);

/* Cover routines for ESM Module procedures */
mf_uns32 SafEsmCVerify(mf_uns32 EsmIdx, struct safpb_parameter_block *);
mf_uns32 SafEsmCAuth(mf_uns32 EsmIdx, struct safpb_parameter_block *);
mf_uns32 SafEsmCXAuth(mf_uns32 EsmIdx, struct safpb_parameter_block *);
mf_uns32 SafEsmCAdmin(mf_uns32 EsmIdx, struct safpb_parameter_block *);
mf_uns32 SafEsmCUpdate(mf_s32 Type, mf_uns32 EsmIdx,
                       struct safpb_parameter_block *);


#endif

/* End of saf-esm.h */