Logo Search packages:      
Sourcecode: virtualbox-ose version File versions  Download package

SecureTransportPriv.h

/*
 * Copyright (c) 2000-2001 Apple Computer, Inc. All Rights Reserved.
 * 
 * The contents of this file constitute Original Code as defined in and are
 * subject to the Apple Public Source License Version 1.2 (the 'License').
 * You may not use this file except in compliance with the License. Please obtain
 * a copy of the License at http://www.apple.com/publicsource and read it before
 * using this file.
 * 
 * This Original Code and all software distributed under the License are
 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS
 * OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES, INCLUDING WITHOUT
 * LIMITATION, ANY WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
 * PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT. Please see the License for the
 * specific language governing rights and limitations under the License.
 */


/*
      File:       SecureTransportPriv.h

      Contains:   Apple-private exported routines

      Copyright: (c) 1999 by Apple Computer, Inc., all rights reserved.

*/

#ifndef     _SECURE_TRANSPORT_PRIV_H_
#define _SECURE_TRANSPORT_PRIV_H_   1

#include <Security/SecureTransport.h>
#include <Security/SecTrust.h>

#ifdef __cplusplus
extern "C" {
#endif

/* The size of of client- and server-generated random numbers in hello messages. */
#define SSL_CLIENT_SRVR_RAND_SIZE         32

/* The size of the pre-master and master secrets. */
#define SSL_RSA_PREMASTER_SECRET_SIZE     48
#define SSL_MASTER_SECRET_SIZE                  48

/*
 * For the following three functions, *size is the available 
 * buffer size on entry and the actual size of the data returned
 * on return. The above consts are for convenience.
 */
OSStatus SSLInternalMasterSecret(
   SSLContextRef context,
   void *secret,         // mallocd by caller, SSL_MASTER_SECRET_SIZE 
   size_t *secretSize);  // in/out   

OSStatus SSLInternalServerRandom(
   SSLContextRef context,
   void *rand,                // mallocd by caller, SSL_CLIENT_SRVR_RAND_SIZE
   size_t *randSize);   // in/out   

OSStatus SSLInternalClientRandom(
   SSLContextRef context,
   void *rand,          // mallocd by caller, SSL_CLIENT_SRVR_RAND_SIZE
   size_t *randSize);   // in/out   

OSStatus SSLInternal_PRF(
   SSLContextRef context,
   const void *secret,
   size_t secretLen,
   const void *label,
   size_t labelLen,
   const void *seed,
   size_t seedLen,
   void *out,           // mallocd by caller, length >= outLen
   size_t outLen);

/*
 * Obtain a SecTrustRef representing peer certificates. Valid anytime,
 * subsequent to a handshake attempt. The returned SecTrustRef is valid
 * only as long as the SSLContextRef is. 
 */
OSStatus
SSLGetPeerSecTrust                  (SSLContextRef          context,
                                           SecTrustRef            *secTrust); /* RETURNED */
                                          
/*
 * Obtain resumable session info. Can be called anytime subsequent to 
 * handshake attempt. 
 * 
 * if sessionWasResumed is True on return, the session is indeed a
 * resumed session; the sessionID (an opaque blob generated by the 
 * server) is returned in *sessionID. The length of the sessionID
 * is returned in *sessionIDLength. Caller must allocate the 
 * sessionID buffer; it max size is MAX_SESSION_ID_LENGTH bytes. 
 */
#define MAX_SESSION_ID_LENGTH 32

OSStatus 
SSLGetResumableSessionInfo    (
      SSLContextRef     context,
      Boolean                 *sessionWasResumed,           // RETURNED
      void              *sessionID,                   // RETURNED, mallocd by caller
      size_t                  *sessionIDLength);            // IN/OUT
                              
/*
 * Getters for SSLSetCertificate() and SSLSetEncryptionCertificate()
 */
OSStatus
SSLGetCertificate (
      SSLContextRef     context,
      CFArrayRef        *certRefs);                   // RETURNED, *not* retained
      
OSStatus
SSLGetEncryptionCertificate (
      SSLContextRef     context,
      CFArrayRef        *certRefs);                   // RETURNED, *not* retained

#ifdef __cplusplus
}
#endif

#endif      /* _SECURE_TRANSPORT_PRIV_H_ */

Generated by  Doxygen 1.6.0   Back to index