libsecurity_ssl/lib/sslUtils.h

   1 /*
   2  * Copyright (c) 2000-2001,2005-2007,2010-2012 Apple Inc. All Rights Reserved.
   3  *
   4  * @APPLE_LICENSE_HEADER_START@
   5  *
   6  * This file contains Original Code and/or Modifications of Original Code
   7  * as defined in and that are subject to the Apple Public Source License
   8  * Version 2.0 (the 'License'). You may not use this file except in
   9  * compliance with the License. Please obtain a copy of the License at
  10  * http://www.opensource.apple.com/apsl/ and read it before using this
  11  * file.
  12  *
  13  * The Original Code and all software distributed under the License are
  14  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  15  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  16  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  17  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  18  * Please see the License for the specific language governing rights and
  19  * limitations under the License.
  20  *
  21  * @APPLE_LICENSE_HEADER_END@
  22  */
  23
  24 /*
  25  * sslUtils.h
  26  */
  27
  28 #ifndef _SSLUTILS_H_
  29 #define _SSLUTILS_H_ 1
  30
  31 #include "SecureTransport.h"
  32 #include "sslPriv.h"
  33
  34 #ifdef  __cplusplus
  35 extern "C" {
  36 #endif
  37
  38 uint32_t SSLDecodeInt(
  39         const uint8_t *     p,
  40         size_t              length);
  41 uint8_t *SSLEncodeInt(
  42         uint8_t             *p,
  43         uint32_t            value,
  44         size_t length);
  45
  46 /* Same, but the value to encode is a size_t */
  47 size_t SSLDecodeSize(
  48       const uint8_t *     p,
  49       size_t              length);
  50 uint8_t *SSLEncodeSize(
  51       uint8_t             *p,
  52       size_t              value,
  53       size_t              length);
  54
  55 /* Same but for 64bits int */
  56 uint8_t* SSLEncodeUInt64(
  57         uint8_t             *p,
  58         sslUint64           value);
  59 void IncrementUInt64(
  60         sslUint64                       *v);
  61 #if ENABLE_DTLS
  62 void SSLDecodeUInt64(
  63     const uint8_t *p,
  64     size_t length,
  65     sslUint64 *v);
  66 #endif
  67
  68 static inline
  69 int SSLHandshakeHeaderSize(SSLRecord *rec)
  70 {
  71     if(rec->protocolVersion==DTLS_Version_1_0)
  72         return 12;
  73     else
  74         return 4;
  75 }
  76
  77 uint8_t *SSLEncodeHandshakeHeader(
  78     SSLContext *ctx,
  79     SSLRecord *rec,
  80     SSLHandshakeType type,
  81     size_t msglen);
  82
  83 #ifdef USE_SSLCERTIFICATE
  84 size_t SSLGetCertificateChainLength(
  85         const SSLCertificate *c);
  86 OSStatus sslDeleteCertificateChain(
  87         SSLCertificate          *certs,
  88         SSLContext                      *ctx);
  89 #endif /* USE_SSLCERTIFICATE */
  90
  91 Boolean sslIsSessionActive(
  92         const SSLContext        *ctx);
  93
  94 OSStatus sslTime(
  95         uint32_t            *tim);
  96
  97 #if     SSL_DEBUG
  98 extern const char *protocolVersStr(
  99         SSLProtocolVersion      prot);
 100 #endif
 101
 102 /*
 103  * Redirect SSLBuffer-based I/O call to user-supplied I/O.
 104  */
 105 OSStatus sslIoRead(
 106         SSLBuffer               buf,
 107         size_t                  *actualLength,
 108         SSLContext              *ctx);
 109
 110 OSStatus sslIoWrite(
 111         SSLBuffer               buf,
 112         size_t                  *actualLength,
 113         SSLContext              *ctx);
 114
 115 /*
 116  * Common RNG function.
 117  */
 118 OSStatus sslRand(
 119         SSLContext              *ctx,
 120         SSLBuffer               *buf);
 121
 122 OSStatus sslVerifyProtVersion(
 123         SSLContext                      *ctx,
 124         SSLProtocolVersion      peerVersion,
 125         SSLProtocolVersion      *negVersion);
 126
 127 OSStatus sslGetMaxProtVersion(
 128         SSLContext                      *ctx,
 129         SSLProtocolVersion      *version);      // RETURNED
 130
 131 static inline bool sslVersionIsLikeTls12(SSLContext *ctx)
 132 {
 133     assert(ctx->negProtocolVersion!=SSL_Version_Undetermined);
 134     return ctx->isDTLS ? ctx->negProtocolVersion > DTLS_Version_1_0 : ctx->negProtocolVersion >= TLS_Version_1_2;
 135 }
 136
 137 #define SET_SSL_BUFFER(buf, d, l)   do { (buf).data = (d); (buf).length = (l); } while (0)
 138
 139 #ifdef  __cplusplus
 140 }
 141 #endif
 142
 143 #endif