keyintf.h

Go to the documentation of this file.

/* KB  12/31/01  \Ken90\Include\3rdParty\keyintf.h
 * keyintf.h -- KeyObtain(), KeyStatus(), KeyReturn(),
 *                KeyEncrypt(), KeyVersion(), KeyIntf3XXX()
 *
 * (c) 1990-98 Sassafras Software, Inc.
 */

#ifndef  __KEYINTF__
#define __KEYINTF__  0x5000

#define SC_DETACHABLE   0x01  /* key can be reclaimed by KeyServer (or connection can go down) without affecting program */
#define SC_LOCALZONE 0x02  /* key can be obtained by this client only if client and server are in the same zone */
#define SC_SRVRSPECIFIC 0x04  /* key can be obtained only if server IDs match.  Not applicable to remote function keys */
#define SC_BACKGDWARN   0x08  /* give warnings if program is left in the background for too long */
#define SC_MULTILAUNCH  0x40  /* key can be shared between multiple instances of the program on the same computer */
#define SC_HAVEKEY      0x80  /* key is valid and held by this client (app must quit if SC_HAVEKEY and SC_DETACHABLE are both zero) */

#define SDV_NOQUIT      0x00200000  /* don't force program to quit if key becomes invalid */
#define SDV_NOPTCH      0x00400000  /* don't patch ExitToShell (program calls KeyReturn) */
#define SDV_DEFER    0x00800000  /* don't post alert message until next SystemTask */
#define  SDV_NOCUST     0x04000000  /* don't post custom message (pass back in custBuffer) */
#define  SDV_NONTFY     0x08000000  /* don't ask if user wants notification (on denial) */
#define SDV_NOINIT      0x10000000  /* don't init managers on key denial (to post message) */
#define SDV_NOPOST      0x20000000  /* don't post messages on key denial */
#define SDV_NOEXIT      0x40000000  /* don't call ExitToShell on key denial */
#define SDV_NOCSUM      0x80000000  /* don't compute checksum before accepting key */

/* Remote Functions typically use SDV_NOCSUM, SDV_NOEXIT, SDV_NOINIT */
/* INITs typically use SDV_NOCSUM, SDV_NOEXIT, SDV_NOPOST, SDV_NOINIT, SDV_NOPTCH */

#define KEY_SUCCESS        0
#define KEY_FAILURE        -1

#define  KEY_FIRSTERR      -10000
#define KEY_NOTAVAIL    -10000   /* key is not available, and user is not on notification queue */
#define KEY_MAXUSERS    -10001   /* the keyserver is already supporting the maximum number of clients */
#define KEY_MAXAPPS        -10002   /* the maximum number of keyed programs are already available */
#define KEY_REMOTEDENY     -10003   /* the remote function has denied this key for reasons only you know */
#define KEY_OLDPROGRAM     -10004   /* the program is too old for this version of the client software */
#define KEY_ONQUEUE        -10005   /* key is not available - client requested to be placed on queue */
#define KEY_NOSELECTION    -10006   /* there is no KeyServer chosen */
#define KEY_OLDCLIENT      -10007   /* the client software is too old to get a key for this program */
#define KEY_NORESPONSE     -10008   /* no response from the server (server WAS found on the network) */
#define KEY_NOREASON    -10009   /* key is not available - no reason was given for denial */
#define KEY_UNKNOWN        -10010   /* unknown response was received from the server */
#define KEY_BADCHKSUM      -10011   /* key received had a diferent checksum than that provided */
#define KEY_IDDIFFERS      -10012   /* this app was keyed by a different KeyServer than the one currently chosen */
#define KEY_AUTHABORT      -10013   /* this app requires authentication (user cancelled authentication) */
#define KEY_NOTAUTHED      -10014   /* this app requires authentication (user failed to type correct password) */
#define KEY_USRUNKNOWN     -10015   /* the user name typed in the chooser (or auth dialog) is not known */
#define KEY_PERMDENIED     -10016   /* the user named is never allowed to log on to the chosen server */
#define KEY_GUESTONLY      -10017   /* the user named is allowed to log on to the chosen server as a guest only */
#define KEY_BADCACHE    -10018   /* the user attempted to use the key from the key cache, but it was improper */
#define KEY_CACHEABORT     -10019   /* there is a key in the cache, but the user cancelled or typed a bad password */
#define KEY_NOTKEYED    -10020   /* returned by KeyStatus if the indicated program is not keyed */
#define KEY_NOTSYSVOLUME   -10021   /* there is a portable key available, but it must be moved to the system volume */
#define KEY_FLOPPYDISKSYS  -10022   /* there is a portable key available, but it canÕt be used when the System is on a floppy */
#define KEY_PKVERSUNKNOWN  -10023   /* there is a portable key available, but itÕs format version is unknown */
#define KEY_FLOPPYDISK     -10024   /* there is a portable key available, but it canÕt be used from a floppy disk */
#define KEY_NOAFPLAUNCH    -10025   /* the program cannot be launched off of an AFP volume */
#define KEY_MUSTAFPLAUNCH  -10026   /* the program must be launched off of an AFP volume */
#define KEY_SERVERNOTFOUND -10027   /* the server could not be found on the network (Windows only) */
#define KEY_NOTQUEUED      -10028   /* key is not available - user did not want to be notified */
#define KEY_LASTERR        -10028

#define KEY_NOCLIENT    -35      /* KeyAccess was not in the System Folder at startup (generated by glue) */

#define KEY_HANDLE         unsigned long
#define KEY_RESULT         short

//#ifdef MACINTINTOSH
#ifdef _OS9
#undef FAR
#define FAR
#define KEY_ROUTINE(type)  pascal type
#endif

//#ifdef WINDOWS
#ifndef _OS9 
#define KEY_ROUTINE(type)  type WINAPI
#endif

#ifdef __powerc
#pragma options align=mac68k
#endif
#ifdef WIN32
#pragma pack(push)
#pragma pack(2)
#endif
typedef struct ksrr { 
   short length;           /* [out] length of data returned by the remote function */
   short reserved;         /* [out] reserved for future use */
   long  buffer[145];      /* [out] buffer for data returned by the remote function */
} KSResultRec;
#ifdef __powerc
#pragma options align=reset
#endif
#ifdef WIN32
#pragma pack(pop)
#endif

#ifdef __cplusplus
extern "C" {
#endif

KEY_ROUTINE(KEY_RESULT)
KeyObtain (
         char FAR *params,    /* [in]     ->256 bytes of data to be sent to KeyServer */
         long  appID,         /* [in]     unique (and constant) identifier for app (pre-assigned) */
         long  sdvFlags,      /* [in]     flags as detailed above */
         short expLength,     /* [in]     expected length of return result */
         KSResultRec FAR *result,/* [in]     ->500 byte buffer for results to be received from KeyServer */
         unsigned char FAR *name,/* [in]     ->name of program, NULL for default (CurApName) */
         long FAR *userLink,     /* [out] unique user link, to be received from KeyServer */
         KEY_HANDLE FAR *keyh /* [out] on success, reference for the obtained key */
   );

KEY_ROUTINE(KEY_RESULT)
KeyStatusEx (
         KEY_HANDLE keyh,     /* [in]     reference handed back from KeyObtain */
         long FAR *flags,     /* [out] low byte = service class.  See above bits for details */
         long FAR *foreTime,     /* [out] number of seconds that the keyed app has been in foreground */
         long FAR *timeout    /* [out] adsolute time that license (may) expire) */
   );

KEY_ROUTINE(KEY_RESULT)
KeyStatus (
         KEY_HANDLE keyh,     /* [in]     reference handed back from KeyObtain */
         long FAR *flags,     /* [out] low byte = service class.  See above bits for details */
         long FAR *foreTime      /* [out] number of seconds that the keyed app has been in foreground */
   );

KEY_ROUTINE(KEY_RESULT)
KeyUpdate (
         KEY_HANDLE keyh,     /* [in]     reference handed back from KeyObtain */
         char FAR *params,    /* [in]     ->256 bytes of data to be sent to KeyServer */
         KSResultRec FAR *result /* [in/out] ->500 byte buffer for results to be received from KeyServer */
   );

KEY_ROUTINE(KEY_RESULT)
KeyReturn (
         KEY_HANDLE keyh         /* [in]     reference handed back from KeyObtain (as return result) */
   );

KEY_ROUTINE(KEY_RESULT)
KeySession (
         KEY_HANDLE keyh,     /* [in]     reference handed back from KeyObtain */
         long FAR *session    /* [out] session assoctiated with this license */
   );

KEY_ROUTINE(KEY_RESULT)
KeyEncrypt (
         char FAR *data,         /* [in/out] data to encrypt the plaintext (encrypted text returned here) */
         char FAR *text       /* [in]     plaintext key for encryption (remains intact across call) */
   );

KEY_ROUTINE(KEY_RESULT)
KeyVersion (
         short FAR *clientVersion,  /* [out] version of client software (KeyAccess) that is currently running */
         short FAR *serverVersion   /* [out] version of server software (KeyServer), if connection is present */
   );

KEY_ROUTINE(KEY_RESULT)
KeyLog (
         unsigned char FAR *line    /* [in]     line to write in KeyServerÕs log file (return characters are illegal) */
   );

KEY_ROUTINE(KEY_RESULT)
KeyIntf5000 (
         void
   );

#ifdef __cplusplus
}
#endif

#endif /* __KEYINTF__ */

---