keyres.h
上传用户:lyxiangda
上传日期:2007-01-12
资源大小:3042k
文件大小:4k
源码类别:

CA认证

开发平台:

WINDOWS

  1. /* -*- Mode: C; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
  2. /*
  3.  * The contents of this file are subject to the Mozilla Public
  4.  * License Version 1.1 (the "License"); you may not use this file
  5.  * except in compliance with the License. You may obtain a copy of
  6.  * the License at http://www.mozilla.org/MPL/
  7.  * 
  8.  * Software distributed under the License is distributed on an "AS
  9.  * IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
  10.  * implied. See the License for the specific language governing
  11.  * rights and limitations under the License.
  12.  * 
  13.  * The Original Code is the Netscape security libraries.
  14.  * 
  15.  * The Initial Developer of the Original Code is Netscape
  16.  * Communications Corporation.  Portions created by Netscape are 
  17.  * Copyright (C) 1994-2000 Netscape Communications Corporation.  All
  18.  * Rights Reserved.
  19.  * 
  20.  * Contributor(s):
  21.  * 
  22.  * Alternatively, the contents of this file may be used under the
  23.  * terms of the GNU General Public License Version 2 or later (the
  24.  * "GPL"), in which case the provisions of the GPL are applicable 
  25.  * instead of those above.  If you wish to allow use of your 
  26.  * version of this file only under the terms of the GPL and not to
  27.  * allow others to use your version of this file under the MPL,
  28.  * indicate your decision by deleting the provisions above and
  29.  * replace them with the notice and other provisions required by
  30.  * the GPL.  If you do not delete the provisions above, a recipient
  31.  * may use your version of this file under either the MPL or the
  32.  * GPL.
  33.  */
  34. #ifndef _KEYRES_H_
  35. #define _KEYRES_H_
  36. #include "resource.h"
  37. #include "key.h"
  38. #include "ctrlconn.h"
  39. /*
  40.  * FUNCTION: SSM_GenerateKeyPairs
  41.  * INPUTS:
  42.  *    msg
  43.  *        The message sent by the client requesting the key generation.
  44.  *    destID
  45.  *        A pointer to pre-allocated memory where the funciton can place
  46.  *        a copy of the resource id to associate with the newly generated
  47.  *        key pair.
  48.  * NOTES:
  49.  * This function takes a key pair generation method message and performs the
  50.  * actual key generation.
  51.  *
  52.  * RETURN:
  53.  * PRSuccess if the key generation is successfull.  Any other return value 
  54.  * indicates an error while trying to generate the key pair.
  55.  */
  56. extern SSMStatus SSM_GenerateKeyPair(SECItem *msg, SSMResourceID *destID);
  57. /* Forward declare this structure so that builds will work.
  58.  * Unfortunately, there is a circular dependency here.
  59.  */
  60. typedef struct SSMKeyGenContext SSMKeyGenContext;
  61. /* Now we begin to define the KeyPair class */
  62. typedef struct SSMKeyPair {
  63.     SSMResource super;
  64.     SECKEYPublicKey  *m_PubKey;
  65.     SECKEYPrivateKey *m_PrivKey;
  66.     SSMKeyGenContext *m_KeyGenContext;
  67.     SSMKeyGenType     m_KeyGenType;
  68. } SSMKeyPair;
  69. /*
  70.  * This structure should be passed as the argument when creating
  71.  * a key pair.
  72.  */
  73. typedef struct SSMKeyPairArgStr {
  74.     SSMKeyGenContext *keyGenContext;
  75. } SSMKeyPairArg;
  76. /*
  77.  * FUNCTION: SSMKeyPair_Create
  78.  * INPUTS:
  79.  *    arg
  80.  *        An opaque pointer that gets passed while creation is taking place
  81.  *        within the resource code.
  82.  *    res
  83.  *        A pointer to a pointer where a copy of the pointer to the instatiated
  84.  *        class can be placed.
  85.  * NOTES:
  86.  * This is the constructor "method" the resource builder will call when 
  87.  * instatiating a key pair class.
  88.  *
  89.  * RETURN:
  90.  * PRSuccess if creation was successful.  In this case, a valid pointer
  91.  * to an SSMResource will be placed at *res. 
  92.  * Any other return value indicates failure and the value at *res should
  93.  * be ignored. 
  94.  */
  95. extern SSMStatus SSMKeyPair_Create(void *arg, SSMControlConnection * conn, 
  96.                                   SSMResource **res);
  97. extern SSMStatus SSMKeyPair_Init(SSMKeyPair           *inKeyPair, 
  98.                                 SSMControlConnection *conn,
  99.                                 SSMResourceType       type,
  100.                                 SSMKeyGenContext     *keyGenContext);
  101. extern SSMStatus 
  102. SSMKeyPair_SetAttr(SSMResource *res,
  103.                    SSMAttributeID attrID,
  104.                    SSMAttributeValue *value);
  105. extern SSMStatus SSMKeyPair_Destroy(SSMResource *res, PRBool doFree);
  106. #endif /* _KEYRES_H_ */