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

CA认证

开发平台:

WINDOWS

  1. /* 
  2.  * The contents of this file are subject to the Mozilla Public
  3.  * License Version 1.1 (the "License"); you may not use this file
  4.  * except in compliance with the License. You may obtain a copy of
  5.  * the License at http://www.mozilla.org/MPL/
  6.  * 
  7.  * Software distributed under the License is distributed on an "AS
  8.  * IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
  9.  * implied. See the License for the specific language governing
  10.  * rights and limitations under the License.
  11.  * 
  12.  * The Original Code is the Netscape security libraries.
  13.  * 
  14.  * The Initial Developer of the Original Code is Netscape
  15.  * Communications Corporation.  Portions created by Netscape are 
  16.  * Copyright (C) 1994-2000 Netscape Communications Corporation.  All
  17.  * Rights Reserved.
  18.  * 
  19.  * Contributor(s):
  20.  * 
  21.  * Alternatively, the contents of this file may be used under the
  22.  * terms of the GNU General Public License Version 2 or later (the
  23.  * "GPL"), in which case the provisions of the GPL are applicable 
  24.  * instead of those above.  If you wish to allow use of your 
  25.  * version of this file only under the terms of the GPL and not to
  26.  * allow others to use your version of this file under the MPL,
  27.  * indicate your decision by deleting the provisions above and
  28.  * replace them with the notice and other provisions required by
  29.  * the GPL.  If you do not delete the provisions above, a recipient
  30.  * may use your version of this file under either the MPL or the
  31.  * GPL.
  32.  */
  33. /*
  34.   protocol.h - Definitions of various items to support the PSM protocol.
  35.  */
  36. #ifndef __PROTOCOL_H__
  37. #define __PROTOCOL_H__
  38. #include "rsrcids.h"
  39. #define SSMPRStatus SSMStatus
  40. #define SSMPR_SUCCESS SSM_SUCCESS
  41. #define SSMPR_FAILURE SSM_FAILURE
  42. #define SSMPR_INVALID_ARGUMENT_ERROR PR_INVALID_ARGUMENT_ERROR
  43. #define SSMPR_OUT_OF_MEMORY_ERROR    PR_OUT_OF_MEMORY_ERROR
  44. #define SSMPRInt32 PRInt32
  45. #define SSMPRUint32 PRUint32
  46. #define SSMPR_ntohl  PR_ntohl
  47. #define SSMPR_htonl  PR_htonl
  48. #define SSMPORT_Free   PORT_Free
  49. #define SSMPORT_ZAlloc PORT_ZAlloc
  50. #define SSMPR_SetError PR_SetError
  51. #define SSMPR_GetError PR_GetError
  52. #define SSMPORT_SetError PORT_SetError
  53. #define SSMPORT_GetError PORT_GetError
  54. /* 
  55.    Current version of PSM protocol. 
  56.    Increment this value when the protocol changes. 
  57. */
  58. #define SSMSTRING_PADDED_LENGTH(x) ((((x)+3)/4)*4)
  59. #define SSMPORT_ZNEW(type) (type*)SSMPORT_ZAlloc(sizeof(type))
  60. #define SSMPORT_ZNewArray(type,size) (type*)SSMPORT_ZAlloc(sizeof(type)*(size))
  61. /* Various message structs */
  62. struct _SSMHelloRequest {
  63.   CMUint32          m_version; /* Protocol version supported by client */
  64.   struct _SSMString m_profileName; /* Name of user profile (where to find 
  65.  certs etc) */
  66. };
  67. struct _SSMHelloReply {
  68.   CMInt32           m_result; /* Error, if any, which occurred 
  69.  (0 == success) */
  70.   CMUint32          m_version; /* Protocol version supported by PSM */
  71.   struct _SSMString m_nonce; /* Session nonce -- must be written to data channels */
  72. };
  73. struct _SSMRequestSSLDataConnection
  74. {
  75.   CMUint32          m_flags; /* Flags to indicate to SSM what to do with
  76. the connection */
  77.   CMUint32          m_port; /* Port number to connect to */
  78.   struct _SSMString m_hostIP; /* IP address of final target machine (not proxy) */
  79.   /* struct _SSMString m_hostName; Host name of target machine (for server auth) -- not accessed directly */
  80. };
  81. struct _SSMReplySSLDataConnection {
  82.   CMInt32 m_result; /* Error, if any, which occurred (0 == success) */
  83.   CMUint32 m_connectionID; /* Connection ID of newly opened channel */
  84.   CMUint32 m_port; /* Port number to which to connect on PSM */
  85. };
  86. struct _SSMRequestSecurityStatus {
  87.   CMUint32 m_connectionID; /* ID of connection of which to stat */
  88. };
  89. struct _SSMReplySecurityStatus {
  90.   CMInt32 m_result; /* Error, if any, which occurred (0 == success) */
  91.   CMUint32 m_keySize; /* Key size */
  92.   CMUint32 m_secretKeySize; /* Secret key size */
  93.   struct _SSMString m_cipherName; /* Name of cipher in use */
  94.   /* SSMString m_certificate; -- DER encoded cert
  95.      We do not access this as a field, we have to skip over m_cipherName */
  96. };
  97. /* 
  98.    Use this macro to jump over strings.
  99.    For example, if you wanted to access m_certificate above, 
  100.    use a line like the following:
  101.    char *ptr = &(reply->m_cipherName) + SSM_SIZEOF_STRING(reply->m_cipherName);
  102. */
  103. #define SSM_SIZEOF_STRING(str) (SSMSTRING_PADDED_LENGTH(PR_ntohl((str).m_length)) + sizeof(CMUint32))
  104. typedef struct _SSMHelloRequest SSMHelloRequest;
  105. typedef struct _SSMHelloReply SSMHelloReply;
  106. typedef struct _SSMRequestSSLDataConnection SSMRequestSSLDataConnection;
  107. typedef struct _SSMReplySSLDataConnection SSMReplySSLDataConnection;
  108. typedef struct _SSMRequestSecurityStatus SSMRequestSecurityStatus;
  109. typedef struct _SSMReplySecurityStatus SSMReplySecurityStatus;
  110. /* 
  111.    Functions to convert between an SSMString and a C string.
  112.    Return values are allocated using PR_Malloc (which means that
  113.    SSMPR_Free must be used to free up the memory after use). 
  114. */
  115. CMTStatus SSM_StringToSSMString(SSMString ** ssmString, int len, char * string);
  116. CMTStatus SSM_SSMStringToString(char ** string,int *len, SSMString * ssmString);
  117. #endif /* __PROTOCOL_H__ */