DigitalSignature.h
上传用户:xjjlds
上传日期:2015-12-05
资源大小:22823k
文件大小:20k
源码类别:

多媒体编程

开发平台:

Visual C++

  1. /*
  2.      File:       DigitalSignature.h
  3.  
  4.      Contains:   Digital Signature Interfaces.
  5.  
  6.      Version:    Technology: AOCE toolbox 1.02
  7.                  Release:    QuickTime 6.0.2
  8.  
  9.      Copyright:  (c) 1994-2001 by Apple Computer, Inc., all rights reserved.
  10.  
  11.      Bugs?:      For bug reports, consult the following page on
  12.                  the World Wide Web:
  13.  
  14.                      http://developer.apple.com/bugreporter/
  15.  
  16. */
  17. #ifndef __DIGITALSIGNATURE__
  18. #define __DIGITALSIGNATURE__
  19. #ifndef __MACTYPES__
  20. #include "MacTypes.h"
  21. #endif
  22. #ifndef __MIXEDMODE__
  23. #include "MixedMode.h"
  24. #endif
  25. #ifndef __FILES__
  26. #include "Files.h"
  27. #endif
  28. #if PRAGMA_ONCE
  29. #pragma once
  30. #endif
  31. #ifdef __cplusplus
  32. extern "C" {
  33. #endif
  34. #if PRAGMA_IMPORT
  35. #pragma import on
  36. #endif
  37. #if PRAGMA_STRUCT_ALIGN
  38.     #pragma options align=mac68k
  39. #elif PRAGMA_STRUCT_PACKPUSH
  40.     #pragma pack(push, 2)
  41. #elif PRAGMA_STRUCT_PACK
  42.     #pragma pack(2)
  43. #endif
  44. /* values of SIGNameAttributeType */
  45. enum {
  46.     kSIGCountryCode             = 0,
  47.     kSIGOrganization            = 1,
  48.     kSIGStreetAddress           = 2,
  49.     kSIGState                   = 3,
  50.     kSIGLocality                = 4,
  51.     kSIGCommonName              = 5,
  52.     kSIGTitle                   = 6,
  53.     kSIGOrganizationUnit        = 7,
  54.     kSIGPostalCode              = 8
  55. };
  56. typedef unsigned short                  SIGNameAttributeType;
  57. /* 
  58. Certificate status codes returned in SIGCertInfo or SIGSignerInfo from
  59. either SIGGetCertInfo or SIGGetSignerInfo respectively. kSIGValid means that
  60. the certificate is currently valid. kSIGPending means the certificate is
  61. currently not valid - but will be.  kSIGExpired means the certificate has
  62. expired. A time is always associated with a SIGCertStatus.  In each case the
  63. time has a specific interpretation.  When the status is kSIGValid the time is
  64. when the certificate will expire. When the status is kSIGPending the time is
  65. when the certificate will become valid. When the status is kSIGExpired the time
  66. is when the certificate expired. In the SIGCertInfo structure, the startDate
  67. and endDate fields hold the appropriate date information.  In the SIGSignerInfo
  68. structure, this information is provided in the certSetStatusTime field. In the
  69. SIGSignerInfo struct, the status time is actually represented by the SIGSignatureStatus
  70. field which can contain any of the types below. NOTE: The only time you will get 
  71. a kSIGInvalid status is when it pertains to a SIGSignatureStatus field and only when
  72. you get a signature that was created after the certificates expiration date, something
  73. we are not allowing on the Mac but that may not be restricted on other platforms. Also, 
  74. it will not be possible to get a kSIGPending value for SIGSignatureStatus on the Mac but
  75. possibly allowed by other platforms.
  76. */
  77. /* Values for SIGCertStatus or SIGSignatureStatus */
  78. enum {
  79.     kSIGValid                   = 0,                            /* possible for either a SIGCertStatus or SIGSignatureStatus */
  80.     kSIGPending                 = 1,                            /* possible for either a SIGCertStatus or SIGSignatureStatus */
  81.     kSIGExpired                 = 2,                            /* possible for either a SIGCertStatus or SIGSignatureStatus * possible only for a SIGSignatureStatus */
  82.     kSIGInvalid                 = 3
  83. };
  84. typedef unsigned short                  SIGCertStatus;
  85. typedef unsigned short                  SIGSignatureStatus;
  86. /* Number of bytes needed for a digest record when using SIGDigest */
  87. enum {
  88.     kSIGDigestSize              = 16
  89. };
  90. typedef Byte                            SIGDigestData[16];
  91. typedef Byte *                          SIGDigestDataPtr;
  92. struct SIGCertInfo {
  93.     unsigned long                   startDate;                  /* cert start validity date */
  94.     unsigned long                   endDate;                    /* cert end validity date */
  95.     SIGCertStatus                   certStatus;                 /* see comment on SIGCertStatus for definition */
  96.     unsigned long                   certAttributeCount;         /* number of name attributes in this cert */
  97.     unsigned long                   issuerAttributeCount;       /* number of name attributes in this certs issuer */
  98.     Str255                          serialNumber;               /* cert serial number */
  99. };
  100. typedef struct SIGCertInfo              SIGCertInfo;
  101. typedef SIGCertInfo *                   SIGCertInfoPtr;
  102. struct SIGSignerInfo {
  103.     unsigned long                   signingTime;                /* time of signing */
  104.     unsigned long                   certCount;                  /* number of certificates in the cert set */
  105.     unsigned long                   certSetStatusTime;          /* Worst cert status time. See comment on SIGCertStatus for definition */
  106.     SIGSignatureStatus              signatureStatus;            /* The status of the signature. See comment on SIGCertStatus for definition*/
  107. };
  108. typedef struct SIGSignerInfo            SIGSignerInfo;
  109. typedef SIGSignerInfo *                 SIGSignerInfoPtr;
  110. struct SIGNameAttributesInfo {
  111.     Boolean                         onNewLevel;
  112.     Boolean                         filler1;
  113.     SIGNameAttributeType            attributeType;
  114.     ScriptCode                      attributeScript;
  115.     Str255                          attribute;
  116. };
  117. typedef struct SIGNameAttributesInfo    SIGNameAttributesInfo;
  118. typedef SIGNameAttributesInfo *         SIGNameAttributesInfoPtr;
  119. typedef Ptr                             SIGContextPtr;
  120. typedef Ptr                             SIGSignaturePtr;
  121. /*
  122. Certificates are always in order. That is, the signers cert is always 0, the
  123. issuer of the signers cert is always 1 etc... to the number of certificates-1.
  124. You can use this constant for readability in your code.
  125. */
  126. enum {
  127.     kSIGSignerCertIndex         = 0
  128. };
  129. /*
  130. Call back procedure supplied by developer, return false to cancel the current
  131. process.
  132. */
  133. typedef CALLBACK_API( Boolean , SIGStatusProcPtr )(void );
  134. typedef STACK_UPP_TYPE(SIGStatusProcPtr)                        SIGStatusUPP;
  135. #if OPAQUE_UPP_TYPES
  136. #if CALL_NOT_IN_CARBON
  137.     EXTERN_API(SIGStatusUPP)
  138.     NewSIGStatusUPP                (SIGStatusProcPtr        userRoutine);
  139.     EXTERN_API(void)
  140.     DisposeSIGStatusUPP            (SIGStatusUPP            userUPP);
  141.     EXTERN_API(Boolean)
  142.     InvokeSIGStatusUPP             (SIGStatusUPP            userUPP);
  143. #endif  /* CALL_NOT_IN_CARBON */
  144. #else
  145.     enum { uppSIGStatusProcInfo = 0x00000010 };                     /* pascal 1_byte Func() */
  146.     #define NewSIGStatusUPP(userRoutine)                            (SIGStatusUPP)NewRoutineDescriptor((ProcPtr)(userRoutine), uppSIGStatusProcInfo, GetCurrentArchitecture())
  147.     #define DisposeSIGStatusUPP(userUPP)                            DisposeRoutineDescriptor(userUPP)
  148.     #define InvokeSIGStatusUPP(userUPP)                             (Boolean)CALL_ZERO_PARAMETER_UPP((userUPP), uppSIGStatusProcInfo)
  149. #endif
  150. /* support for pre-Carbon UPP routines: NewXXXProc and CallXXXProc */
  151. #define NewSIGStatusProc(userRoutine)                           NewSIGStatusUPP(userRoutine)
  152. #define CallSIGStatusProc(userRoutine)                          InvokeSIGStatusUPP(userRoutine)
  153. /*
  154. Resource id's of standard signature icon suite, all sizes and colors are available.
  155. */
  156. enum {
  157.     kSIGSignatureIconResID      = -16797,
  158.     kSIGValidSignatureIconResID = -16799,
  159.     kSIGInvalidSignatureIconResID = -16798
  160. };
  161. /* ------------------------------- CONTEXT CALLS ------------------------------- 
  162. To use the Digital Signature toolbox you will need a SIGContextPtr.  To create
  163. a SIGContextPtr you simply call SIGNewContext and it will create and initialize
  164. a context for you.  To free the memory occupied by the context and invalidate
  165. its internal data, call SIGDisposeContext. An initialized context has no notion
  166. of the type of operation it will be performing however, once you call
  167. SIGSignPrepare SIGVerifyPrepare, or SIGDigestPrepare, the contexts operation
  168. type is set and to switch  to another type of operation will require creating a
  169. new context. Be sure to pass the same context to corresponding toolbox calls
  170. (ie SIGSignPrepare, SIGProcessData, SIGSign)  in other words mixing lets say
  171. signing and verify calls with the same context is not allowed.
  172. */
  173. #if CALL_NOT_IN_CARBON
  174. EXTERN_API( OSErr )
  175. SIGNewContext                   (SIGContextPtr *        context)                            FOURWORDINLINE(0x203C, 0x0002, 0x076C, 0xAA5D);
  176. EXTERN_API( OSErr )
  177. SIGDisposeContext               (SIGContextPtr          context)                            FOURWORDINLINE(0x203C, 0x0002, 0x076D, 0xAA5D);
  178. /* ------------------------------- SIGNING CALLS ------------------------------- 
  179. Once you have created a SIGContextPtr, you create a signature by calling
  180. SIGSignPrepare once, followed by n calls to SIGProcessData, followed by one call
  181. toRcpt SIGSign. To create another signature on different data but for the same
  182. signer, don't dispose of the context and call SIGProcessData for the new data
  183. followed by a call SIGSign again. In this case the signer will not be prompted
  184. for their signer and password again as it was already provided.  Once you call
  185. SIGDisposeContext, all signer information will be cleared out of the context and
  186. the signer will be re-prompted.  The signer file FSSpecPtr should be set to nil
  187. if you want the toolbox to use the last signer by default or prompt for a signer
  188. if none exists.  The prompt parameter can be used to pass a string to be displayed
  189. in the dialog that prompts the user for their password.  If the substring "^1"
  190. (without the quotes) is in the prompt string, then the toolbox will replace it
  191. with the name of the signer from the signer selected by the user.  If an empty
  192. string is passed, the following default string will be sent to the toolbox
  193. "pSigning as ^1.".  You can call any of the utility routines after SIGSignPrepare
  194. or SIGSign to get information about the signer or certs.
  195. */
  196. EXTERN_API( OSErr )
  197. SIGSignPrepare                  (SIGContextPtr          context,
  198.                                  const FSSpec *         signerFile,
  199.                                  ConstStr255Param       prompt,
  200.                                  Size *                 signatureSize)                      FOURWORDINLINE(0x203C, 0x0008, 0x076E, 0xAA5D);
  201. EXTERN_API( OSErr )
  202. SIGSign                         (SIGContextPtr          context,
  203.                                  SIGSignaturePtr        signature,
  204.                                  SIGStatusUPP           statusProc)                         FOURWORDINLINE(0x203C, 0x0006, 0x076F, 0xAA5D);
  205. /* ------------------------------- VERIFYING CALLS ------------------------------- 
  206. Once you have created a SIGContextPtr, you verify a signature by calling
  207. SIGVerifyPrepare  once, followed by n calls to SIGProcessData, followed by one
  208. call to SIGVerify. Check the return code from SIGVerify to see if the signature
  209. verified or not (noErr is returned on  success otherwise the appropriate error
  210. code).  Upon successfull verification, you can call any of the utility routines
  211. toRcpt find out who signed the data.
  212. */
  213. EXTERN_API( OSErr )
  214. SIGVerifyPrepare                (SIGContextPtr          context,
  215.                                  SIGSignaturePtr        signature,
  216.                                  Size                   signatureSize,
  217.                                  SIGStatusUPP           statusProc)                         FOURWORDINLINE(0x203C, 0x0008, 0x0770, 0xAA5D);
  218. EXTERN_API( OSErr )
  219. SIGVerify                       (SIGContextPtr          context)                            FOURWORDINLINE(0x203C, 0x0002, 0x0771, 0xAA5D);
  220. /* ------------------------------ DIGESTING CALLS ------------------------------ 
  221. Once you have created a SIGContextPtr, you create a digest by calling
  222. SIGDigestPrepare once, followed by n calls to SIGProcessData, followed by one
  223. call to SIGDigest.  You can dispose of the context after SIGDigest as the
  224. SIGDigestData does not reference back into it.  SIGDigest returns the digest in
  225. digest.
  226. */
  227. EXTERN_API( OSErr )
  228. SIGDigestPrepare                (SIGContextPtr          context)                            FOURWORDINLINE(0x203C, 0x0002, 0x0772, 0xAA5D);
  229. EXTERN_API( OSErr )
  230. SIGDigest                       (SIGContextPtr          context,
  231.                                  SIGDigestData          digest)                             FOURWORDINLINE(0x203C, 0x0004, 0x0773, 0xAA5D);
  232. /* ------------------------------ PROCESSING DATA ------------------------------ 
  233. To process data during a digest, sign, or verify operation call SIGProcessData
  234. as many times as necessary and with any sized blocks of data.  The data needs to
  235. be processed in the same order during corresponding sign and verify operations
  236. but does not need to be processed in the same sized chunks (i.e., the toolbox
  237. just sees it as a continuous bit stream).
  238. */
  239. EXTERN_API( OSErr )
  240. SIGProcessData                  (SIGContextPtr          context,
  241.                                  const void *           data,
  242.                                  Size                   dataSize)                           FOURWORDINLINE(0x203C, 0x0006, 0x0774, 0xAA5D);
  243. /* ------------------------------- UTILITY CALLS ------------------------------- 
  244. Given a context that has successfully performed a verification SIGShowSigner
  245. will  display a modal dialog with the entire distinguished name of the person
  246. who signed the data. the prompt (if supplied) will appear at the top of the
  247. dialog.  If no prompt is specified, the default prompt "pVerification
  248. Successfull." will appear.
  249. Given a context that has been populated by calling SIGSignPrepare, SIGSign or a
  250. successful SIGVerify, you can make the remaining utility calls:
  251. SIGGetSignerInfo will return the SignerInfo record.  The certCount can be used
  252. toRcpt index into the certificate set when calling SIGGetCertInfo,
  253. SIGGetCertNameAttributes or SIGGetCertIssuerNameAttributes. The signingTime is
  254. only defined if the call is made after SIGSign  or SIGVerify. The certSetStatus
  255. will tell you the best status of the entire certificate set while
  256. certSetStatusTime will correspond to the time associated with that status (see
  257. definitions above).
  258. SIGGetCertInfo will return the SIGCertInfo record when given a valid index into
  259. the cert set in  certIndex.  Note: The cert at index kSIGSignerCertIndex is
  260. always the signers certificate.  The  serial number, start date and end date
  261. are there should you wish to display that info.  The  certAttributeCount and
  262. issuerAttributeCount provide the number of parts in the name of that certificate
  263. or that certificates issuer respectively.  You use these numbers to index into
  264. either SIGGetCertNameAttributes or SIGGetCertIssuerNameAttributes to retrieve
  265. the name. The certStatus will tell you the status of the certificate while
  266. certStatusTime will correspond to the time associated with that status (see
  267. definitions above).
  268. SIGGetCertNameAttributes and SIGGetCertIssuerNameAttributes return name parts
  269. of the certificate at  certIndex and attributeIndex.  The newLevel return value
  270. tells you wether the name attribute returned is at the same level in the name
  271. hierarchy as the previous attribute.  The type return value tells you  the type
  272. of attribute returned. nameAttribute is the actual string containing the name
  273. attribute.   So, if you wanted to display the entire distinguished name of the
  274. person who's signature was just validated you could do something like this;
  275.     (...... variable declarations and verification code would preceed this sample ......)
  276.     error = SIGGetCertInfo(verifyContext, kSIGSignerCertIndex, &certInfo);
  277.     HandleErr(error);
  278.     for (i = 0; i <= certInfo.certAttributeCount-1; i++)
  279.         {
  280.         error = SIGGetCertNameAttributes(
  281.             verifyContext, kSIGSignerCertIndex, i, &newLevel, &type, theAttribute);
  282.         HandleErr(error);
  283.         DisplayNamePart(theAttribute, type, newLevel);
  284.         }
  285. */
  286. EXTERN_API( OSErr )
  287. SIGShowSigner                   (SIGContextPtr          context,
  288.                                  ConstStr255Param       prompt)                             FOURWORDINLINE(0x203C, 0x0004, 0x0775, 0xAA5D);
  289. EXTERN_API( OSErr )
  290. SIGGetSignerInfo                (SIGContextPtr          context,
  291.                                  SIGSignerInfo *        signerInfo)                         FOURWORDINLINE(0x203C, 0x0004, 0x0776, 0xAA5D);
  292. EXTERN_API( OSErr )
  293. SIGGetCertInfo                  (SIGContextPtr          context,
  294.                                  unsigned long          certIndex,
  295.                                  SIGCertInfo *          certInfo)                           FOURWORDINLINE(0x203C, 0x0006, 0x0777, 0xAA5D);
  296. EXTERN_API( OSErr )
  297. SIGGetCertNameAttributes        (SIGContextPtr          context,
  298.                                  unsigned long          certIndex,
  299.                                  unsigned long          attributeIndex,
  300.                                  SIGNameAttributesInfo * attributeInfo)                     FOURWORDINLINE(0x203C, 0x0008, 0x0778, 0xAA5D);
  301. EXTERN_API( OSErr )
  302. SIGGetCertIssuerNameAttributes  (SIGContextPtr          context,
  303.                                  unsigned long          certIndex,
  304.                                  unsigned long          attributeIndex,
  305.                                  SIGNameAttributesInfo * attributeInfo)                     FOURWORDINLINE(0x203C, 0x0008, 0x0779, 0xAA5D);
  306. /* --------------------------- FILE SIGN & VERIFY CALLS -------------------------- 
  307. These calls allow you to detect the presence of a standard signtaure in a file as 
  308. well as sign and verify files in a standard way.  An example of this is the Finder, 
  309. which uses these calls to allow the user to "drop sign" a file.
  310. To detect if a file is signed in the standard way, pass the FSSpec of the file to SIGFileIsSigned.
  311. A result of noErr means the file is in fact signed, otherwise, a kSIGNoSignature error will
  312. be returned.
  313. Once you have created a SIGContextPtr, you can make calls to either sign or verify a file in
  314. a standard way: 
  315. To sign a file, call SIGSignPrepare followed by 'n' number of calls to SIGSignFile,
  316. passing it the file spec for each file you wish to sign in turn.  You supply the context, the signature 
  317. size that was returned from SIGSignPrepare and an optional call back proc.  The call will take care of all
  318. the processing of data and affixing the signature to the file. If a signature already exists in the file, 
  319. it is replaced with the newly created signature.
  320. To verify a file that was signed using SIGSignFile, call SIGVerifyFile passing it a new context and 
  321. the file spec.  Once this call has completed, if the verification is successfull, you can pass the context 
  322. to SIGShowSigner to display the name of the person who signed the file.
  323. */
  324. EXTERN_API( OSErr )
  325. SIGFileIsSigned                 (const FSSpec *         fileSpec)                           FOURWORDINLINE(0x203C, 0x0002, 0x09C4, 0xAA5D);
  326. EXTERN_API( OSErr )
  327. SIGSignFile                     (SIGContextPtr          context,
  328.                                  Size                   signatureSize,
  329.                                  const FSSpec *         fileSpec,
  330.                                  SIGStatusUPP           statusProc)                         FOURWORDINLINE(0x203C, 0x0008, 0x09C5, 0xAA5D);
  331. EXTERN_API( OSErr )
  332. SIGVerifyFile                   (SIGContextPtr          context,
  333.                                  const FSSpec *         fileSpec,
  334.                                  SIGStatusUPP           statusProc)                         FOURWORDINLINE(0x203C, 0x0006, 0x09C6, 0xAA5D);
  335. #endif  /* CALL_NOT_IN_CARBON */
  336. #if PRAGMA_STRUCT_ALIGN
  337.     #pragma options align=reset
  338. #elif PRAGMA_STRUCT_PACKPUSH
  339.     #pragma pack(pop)
  340. #elif PRAGMA_STRUCT_PACK
  341.     #pragma pack()
  342. #endif
  343. #ifdef PRAGMA_IMPORT_OFF
  344. #pragma import off
  345. #elif PRAGMA_IMPORT
  346. #pragma import reset
  347. #endif
  348. #ifdef __cplusplus
  349. }
  350. #endif
  351. #endif /* __DIGITALSIGNATURE__ */