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

CA认证

开发平台:

WINDOWS

  1. /*
  2.  * Gather (Read) entire SSL2 records from socket into buffer.  
  3.  *
  4.  * The contents of this file are subject to the Mozilla Public
  5.  * License Version 1.1 (the "License"); you may not use this file
  6.  * except in compliance with the License. You may obtain a copy of
  7.  * the License at http://www.mozilla.org/MPL/
  8.  * 
  9.  * Software distributed under the License is distributed on an "AS
  10.  * IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
  11.  * implied. See the License for the specific language governing
  12.  * rights and limitations under the License.
  13.  * 
  14.  * The Original Code is the Netscape security libraries.
  15.  * 
  16.  * The Initial Developer of the Original Code is Netscape
  17.  * Communications Corporation.  Portions created by Netscape are 
  18.  * Copyright (C) 1994-2000 Netscape Communications Corporation.  All
  19.  * Rights Reserved.
  20.  * 
  21.  * Contributor(s):
  22.  * 
  23.  * Alternatively, the contents of this file may be used under the
  24.  * terms of the GNU General Public License Version 2 or later (the
  25.  * "GPL"), in which case the provisions of the GPL are applicable 
  26.  * instead of those above.  If you wish to allow use of your 
  27.  * version of this file only under the terms of the GPL and not to
  28.  * allow others to use your version of this file under the MPL,
  29.  * indicate your decision by deleting the provisions above and
  30.  * replace them with the notice and other provisions required by
  31.  * the GPL.  If you do not delete the provisions above, a recipient
  32.  * may use your version of this file under either the MPL or the
  33.  * GPL.
  34.  *
  35.  * $Id: sslgathr.c,v 1.1.14.1 2000/12/02 01:01:15 nelsonb%netscape.com Exp $
  36.  */
  37. #include "cert.h"
  38. #include "ssl.h"
  39. #include "sslimpl.h"
  40. #include "sslproto.h"
  41. /* Forward static declarations */
  42. static SECStatus ssl2_HandleV3HandshakeRecord(sslSocket *ss);
  43. /*
  44. ** Gather a single record of data from the receiving stream. This code
  45. ** first gathers the header (2 or 3 bytes long depending on the value of
  46. ** the most significant bit in the first byte) then gathers up the data
  47. ** for the record into gs->buf. This code handles non-blocking I/O
  48. ** and is to be called multiple times until sec->recordLen != 0.
  49. ** This function decrypts the gathered record in place, in gs_buf.
  50.  *
  51.  * Caller must hold RecvBufLock. 
  52.  *
  53.  * Returns +1 when it has gathered a complete SSLV2 record.
  54.  * Returns  0 if it hits EOF.
  55.  * Returns -1 (SECFailure)    on any error
  56.  * Returns -2 (SECWouldBlock) when it gathers an SSL v3 client hello header.
  57. **
  58. ** The SSL2 Gather State machine has 4 states:
  59. ** GS_INIT   - Done reading in previous record.  Haven't begun to read in
  60. **             next record.  When ssl2_GatherData is called with the machine
  61. **             in this state, the machine will attempt to read the first 3
  62. **             bytes of the SSL2 record header, and will advance the state
  63. **             to GS_HEADER.
  64. **
  65. ** GS_HEADER - The machine is in this state while waiting for the completion
  66. **             of the first 3 bytes of the SSL2 record.  When complete, the
  67. **             machine will compute the remaining unread length of this record
  68. **             and will initiate a read of that many bytes.  The machine will
  69. **             advance to one of two states, depending on whether the record
  70. **             is encrypted (GS_MAC), or unencrypted (GS_DATA).
  71. **
  72. ** GS_MAC    - The machine is in this state while waiting for the remainder 
  73. **             of the SSL2 record to be read in.  When the read is completed,
  74. **             the machine checks the record for valid length, decrypts it,
  75. **             and checks and discards the MAC, then advances to GS_INIT.
  76. **
  77. ** GS_DATA   - The machine is in this state while waiting for the remainder
  78. **             of the unencrypted SSL2 record to be read in.  Upon completion,
  79. **             the machine advances to the GS_INIT state and returns the data.
  80. */
  81. int 
  82. ssl2_GatherData(sslSocket *ss, sslGather *gs, int flags)
  83. {
  84.     sslSecurityInfo *sec  = ss->sec;
  85.     unsigned char *  bp;
  86.     unsigned char *  pBuf;
  87.     int              nb, err, rv;
  88.     PORT_Assert( ssl_HaveRecvBufLock(ss) );
  89.     if (gs->state == GS_INIT) {
  90. /* Initialize gathering engine */
  91. gs->state         = GS_HEADER;
  92. gs->remainder     = 3;
  93. gs->count         = 3;
  94. gs->offset        = 0;
  95. gs->recordLen     = 0;
  96. gs->recordPadding = 0;
  97. gs->hdr[2]        = 0;
  98. gs->writeOffset   = 0;
  99. gs->readOffset    = 0;
  100.     }
  101.     if (gs->encrypted) {
  102. PORT_Assert(sec != 0);
  103.     }
  104.     pBuf = gs->buf.buf;
  105.     for (;;) {
  106. SSL_TRC(30, ("%d: SSL[%d]: gather state %d (need %d more)",
  107.      SSL_GETPID(), ss->fd, gs->state, gs->remainder));
  108. bp = ((gs->state != GS_HEADER) ? pBuf : gs->hdr) + gs->offset;
  109. nb = ssl_DefRecv(ss, bp, gs->remainder, flags);
  110. if (nb > 0) {
  111.     PRINT_BUF(60, (ss, "raw gather data:", bp, nb));
  112. }
  113. if (nb == 0) {
  114.     /* EOF */
  115.     SSL_TRC(30, ("%d: SSL[%d]: EOF", SSL_GETPID(), ss->fd));
  116.     rv = 0;
  117.     break;
  118. }
  119. if (nb < 0) {
  120.     SSL_DBG(("%d: SSL[%d]: recv error %d", SSL_GETPID(), ss->fd,
  121.      PR_GetError()));
  122.     rv = SECFailure;
  123.     break;
  124. }
  125. gs->offset    += nb;
  126. gs->remainder -= nb;
  127. if (gs->remainder > 0) {
  128.     continue;
  129. }
  130. /* Probably finished this piece */
  131. switch (gs->state) {
  132. case GS_HEADER: 
  133.     if ((ss->enableSSL3 || ss->enableTLS) && !ss->connected) {
  134. PORT_Assert( ssl_Have1stHandshakeLock(ss) );
  135. /* If this looks like an SSL3 handshake record, 
  136. ** and we're expecting an SSL2 Hello message from our peer, 
  137. ** handle it here.
  138. */
  139. if (gs->hdr[0] == content_handshake) {
  140.     if ((ss->nextHandshake == ssl2_HandleClientHelloMessage) ||
  141. (ss->nextHandshake == ssl2_HandleServerHelloMessage)) {
  142. rv = ssl2_HandleV3HandshakeRecord(ss);
  143. if (rv == SECFailure) {
  144.     return SECFailure;
  145. }
  146.     }
  147.     /* XXX_1 The call stack to here is:
  148.      * ssl_Do1stHandshake -> ssl_GatherRecord1stHandshake -> 
  149.      * ssl2_GatherRecord -> here.
  150.      * We want to return all the way out to ssl_Do1stHandshake,
  151.      * and have it call ssl_GatherRecord1stHandshake again. 
  152.      * ssl_GatherRecord1stHandshake will call 
  153.      * ssl3_GatherCompleteHandshake when it is called again.
  154.      *
  155.      * Returning SECWouldBlock here causes 
  156.      * ssl_GatherRecord1stHandshake to return without clearing 
  157.      * ss->handshake, ensuring that ssl_Do1stHandshake will 
  158.      * call it again immediately.
  159.      * 
  160.      * If we return 1 here, ssl_GatherRecord1stHandshake will 
  161.      * clear ss->handshake before returning, and thus will not 
  162.      * be called again by ssl_Do1stHandshake.  
  163.      */
  164.     return SECWouldBlock;
  165. } else if (gs->hdr[0] == content_alert) {
  166.     if (ss->nextHandshake == ssl2_HandleServerHelloMessage) {
  167. /* XXX This is a hack.  We're assuming that any failure
  168.  * XXX on the client hello is a failure to match
  169.  * XXX ciphers.
  170.  */
  171. PORT_SetError(SSL_ERROR_NO_CYPHER_OVERLAP);
  172. return SECFailure;
  173.     }
  174. }
  175.     } /* ((ss->enableSSL3 || ss->enableTLS) && !ss->connected) */
  176.     /* we've got the first 3 bytes.  The header may be two or three. */
  177.     if (gs->hdr[0] & 0x80) {
  178. /* This record has a 2-byte header, and no padding */
  179. gs->count = ((gs->hdr[0] & 0x7f) << 8) | gs->hdr[1];
  180. gs->recordPadding = 0;
  181.     } else {
  182. /* This record has a 3-byte header that is all read in now. */
  183. gs->count = ((gs->hdr[0] & 0x3f) << 8) | gs->hdr[1];
  184.     /*  is_escape =  (gs->hdr[0] & 0x40) != 0; */
  185. gs->recordPadding = gs->hdr[2];
  186.     }
  187.     if (gs->count > gs->buf.space) {
  188. err = sslBuffer_Grow(&gs->buf, gs->count);
  189. if (err) {
  190.     return err;
  191. }
  192. pBuf = gs->buf.buf;
  193.     }
  194.     if (gs->hdr[0] & 0x80) {
  195.      /* we've already read in the first byte of the body.
  196. ** Put it into the buffer.
  197. */
  198. pBuf[0]        = gs->hdr[2];
  199. gs->offset    = 1;
  200. gs->remainder = gs->count - 1;
  201.     } else {
  202. gs->offset    = 0;
  203. gs->remainder = gs->count;
  204.     }
  205.     if (gs->encrypted) {
  206. gs->state     = GS_MAC;
  207. gs->recordLen = gs->count - gs->recordPadding
  208.     - sec->hash->length;
  209.     } else {
  210. gs->state     = GS_DATA;
  211. gs->recordLen = gs->count;
  212.     }
  213.     break;
  214. case GS_MAC:
  215.     /* Have read in entire rest of the ciphertext.  
  216.     ** Check for valid length.
  217.     ** Decrypt it.
  218.     ** Check the MAC.
  219.     */
  220.     PORT_Assert(gs->encrypted);
  221.   {
  222.     unsigned int     macLen;
  223.     int              nout;
  224.     unsigned char    mac[SSL_MAX_MAC_BYTES];
  225.     ssl_GetSpecReadLock(ss); /**********************************/
  226.     /* If this is a stream cipher, blockSize will be 1,
  227.      * and this test will always be false.
  228.      * If this is a block cipher, this will detect records
  229.      * that are not a multiple of the blocksize in length.
  230.      */
  231.     if (gs->count & (sec->blockSize - 1)) {
  232. /* This is an error. Sender is misbehaving */
  233. SSL_DBG(("%d: SSL[%d]: sender, count=%d blockSize=%d",
  234.  SSL_GETPID(), ss->fd, gs->count,
  235.  sec->blockSize));
  236. PORT_SetError(SSL_ERROR_BAD_BLOCK_PADDING);
  237. rv = SECFailure;
  238. goto spec_locked_done;
  239.     }
  240.     PORT_Assert(gs->count == gs->offset);
  241.     if (gs->offset == 0) {
  242. rv = 0; /* means EOF. */
  243. goto spec_locked_done;
  244.     }
  245.     /* Decrypt the portion of data that we just recieved.
  246.     ** Decrypt it in place.
  247.     */
  248.     rv = (*sec->dec)(sec->readcx, pBuf, &nout, gs->offset,
  249.      pBuf, gs->offset);
  250.     if (rv != SECSuccess) {
  251. goto spec_locked_done;
  252.     }
  253.     /* Have read in all the MAC portion of record 
  254.     **
  255.     ** Prepare MAC by resetting it and feeding it the shared secret
  256.     */
  257.     macLen = sec->hash->length;
  258.     if (gs->offset >= macLen) {
  259. uint32           sequenceNumber = sec->rcvSequence++;
  260. unsigned char    seq[4];
  261. seq[0] = (unsigned char) (sequenceNumber >> 24);
  262. seq[1] = (unsigned char) (sequenceNumber >> 16);
  263. seq[2] = (unsigned char) (sequenceNumber >> 8);
  264. seq[3] = (unsigned char) (sequenceNumber);
  265. (*sec->hash->begin)(sec->hashcx);
  266. (*sec->hash->update)(sec->hashcx, sec->rcvSecret.data,
  267.      sec->rcvSecret.len);
  268. (*sec->hash->update)(sec->hashcx, pBuf + macLen, 
  269.      gs->offset - macLen);
  270. (*sec->hash->update)(sec->hashcx, seq, 4);
  271. (*sec->hash->end)(sec->hashcx, mac, &macLen, macLen);
  272.     }
  273.     PORT_Assert(macLen == sec->hash->length);
  274.     ssl_ReleaseSpecReadLock(ss);  /******************************/
  275.     if (PORT_Memcmp(mac, pBuf, macLen) != 0) {
  276. /* MAC's didn't match... */
  277. SSL_DBG(("%d: SSL[%d]: mac check failed, seq=%d",
  278.  SSL_GETPID(), ss->fd, sec->rcvSequence));
  279. PRINT_BUF(1, (ss, "computed mac:", mac, macLen));
  280. PRINT_BUF(1, (ss, "received mac:", pBuf, macLen));
  281. PORT_SetError(SSL_ERROR_BAD_MAC_READ);
  282. rv = SECFailure;
  283. goto cleanup;
  284.     }
  285.     PORT_Assert(gs->recordPadding + macLen <= gs->offset);
  286.     if (gs->recordPadding + macLen <= gs->offset) {
  287. gs->recordOffset  = macLen;
  288. gs->readOffset    = macLen;
  289. gs->writeOffset   = gs->offset - gs->recordPadding;
  290. rv = 1;
  291.     } else {
  292. PORT_SetError(SSL_ERROR_BAD_BLOCK_PADDING);
  293. cleanup:
  294. /* nothing in the buffer any more. */
  295. gs->recordOffset  = 0;
  296. gs->readOffset    = 0;
  297.      gs->writeOffset   = 0;
  298. rv = SECFailure;
  299.     }
  300.     gs->recordLen     = gs->writeOffset - gs->readOffset;
  301.     gs->recordPadding = 0; /* forget we did any padding. */
  302.     gs->state = GS_INIT;
  303.     if (rv > 0) {
  304. PRINT_BUF(50, (ss, "recv clear record:", 
  305.                pBuf + gs->recordOffset, gs->recordLen));
  306.     }
  307.     return rv;
  308. spec_locked_done:
  309.     ssl_ReleaseSpecReadLock(ss);
  310.     return rv;
  311.   }
  312. case GS_DATA:
  313.     /* Have read in all the DATA portion of record */
  314.     gs->recordOffset  = 0;
  315.     gs->readOffset    = 0;
  316.     gs->writeOffset   = gs->offset;
  317.     PORT_Assert(gs->recordLen == gs->writeOffset - gs->readOffset);
  318.     gs->recordLen     = gs->offset;
  319.     gs->recordPadding = 0;
  320.     gs->state         = GS_INIT;
  321.     ++sec->rcvSequence;
  322.     PRINT_BUF(50, (ss, "recv clear record:", 
  323.                    pBuf + gs->recordOffset, gs->recordLen));
  324.     return 1;
  325. } /* end switch gs->state */
  326.     } /* end gather loop. */
  327.     return rv;
  328. }
  329. /*
  330. ** Gather a single record of data from the receiving stream. This code
  331. ** first gathers the header (2 or 3 bytes long depending on the value of
  332. ** the most significant bit in the first byte) then gathers up the data
  333. ** for the record into the readBuf. This code handles non-blocking I/O
  334. ** and is to be called multiple times until sec->recordLen != 0.
  335.  *
  336.  * Returns +1 when it has gathered a complete SSLV2 record.
  337.  * Returns  0 if it hits EOF.
  338.  * Returns -1 (SECFailure)    on any error
  339.  * Returns -2 (SECWouldBlock) 
  340.  *
  341.  * Called by ssl_GatherRecord1stHandshake in sslcon.c, 
  342.  * and by DoRecv in sslsecur.c
  343.  * Caller must hold RecvBufLock.
  344.  */
  345. int 
  346. ssl2_GatherRecord(sslSocket *ss, int flags)
  347. {
  348.     return ssl2_GatherData(ss, ss->gather, flags);
  349. }
  350. /*
  351.  * Returns +1 when it has gathered a complete SSLV2 record.
  352.  * Returns  0 if it hits EOF.
  353.  * Returns -1 (SECFailure)    on any error
  354.  * Returns -2 (SECWouldBlock) 
  355.  *
  356.  * Called from SocksStartGather in sslsocks.c
  357.  * Caller must hold RecvBufLock. 
  358.  */
  359. int 
  360. ssl2_StartGatherBytes(sslSocket *ss, sslGather *gs, unsigned int count)
  361. {
  362.     int rv;
  363.     PORT_Assert( ssl_HaveRecvBufLock(ss) );
  364.     gs->state     = GS_DATA;
  365.     gs->remainder = count;
  366.     gs->count     = count;
  367.     gs->offset    = 0;
  368.     if (count > gs->buf.space) {
  369. rv = sslBuffer_Grow(&gs->buf, count);
  370. if (rv) {
  371.     return rv;
  372. }
  373.     }
  374.     return ssl2_GatherData(ss, gs, 0);
  375. }
  376. /* Caller should hold RecvBufLock. */
  377. sslGather *
  378. ssl_NewGather(void)
  379. {
  380.     sslGather *gs;
  381.     gs = (sslGather*) PORT_ZAlloc(sizeof(sslGather));
  382.     if (gs) {
  383. gs->state = GS_INIT;
  384.     }
  385.     return gs;
  386. }
  387. /* Caller must hold RecvBufLock. */
  388. void 
  389. ssl_DestroyGather(sslGather *gs)
  390. {
  391.     if (gs) { /* the PORT_*Free functions check for NULL pointers. */
  392. PORT_ZFree(gs->buf.buf, gs->buf.space);
  393. PORT_Free(gs->inbuf.buf);
  394. PORT_Free(gs);
  395.     }
  396. }
  397. /* Caller must hold RecvBufLock. */
  398. static SECStatus
  399. ssl2_HandleV3HandshakeRecord(sslSocket *ss)
  400. {
  401.     sslGather *         gs       = ss->gather;
  402.     SECStatus           rv;
  403.     SSL3ProtocolVersion version  = (gs->hdr[1] << 8) | gs->hdr[2];
  404.     PORT_Assert( ssl_HaveRecvBufLock(ss) );
  405.     PORT_Assert( ssl_Have1stHandshakeLock(ss) );
  406.     /* We've read in 3 bytes, there are 2 more to go in an ssl3 header. */
  407.     gs->remainder         = 2;
  408.     gs->count             = 0;
  409.     /* Clearing these handshake pointers ensures that 
  410.      * ssl_Do1stHandshake won't call ssl2_HandleMessage when we return.
  411.      */
  412.     ss->nextHandshake     = 0;
  413.     ss->securityHandshake = 0;
  414.     /* Setting ss->version to an SSL 3.x value will cause 
  415.     ** ssl_GatherRecord1stHandshake to invoke ssl3_GatherCompleteHandshake() 
  416.     ** the next time it is called.
  417.     **/
  418.     rv = ssl3_NegotiateVersion(ss, version);
  419.     if (rv != SECSuccess) {
  420. return rv;
  421.     }
  422.     ss->sec->send         = ssl3_SendApplicationData;
  423.     return SECSuccess;
  424. }