Security-58286.41.2.tar.gz

[apple/security.git] / OSX / libsecurity_ssl / lib / sslDebug.h

/*
 * Copyright (c) 2000-2001,2005-2007,2010-2012,2014 Apple Inc. All Rights Reserved.
 *
 * @APPLE_LICENSE_HEADER_START@
 * 
 * This file contains Original Code and/or Modifications of Original Code
 * as defined in and that are subject to the Apple Public Source License
 * Version 2.0 (the 'License'). You may not use this file except in
 * compliance with the License. Please obtain a copy of the License at
 * http://www.opensource.apple.com/apsl/ and read it before using this
 * file.
 * 
 * The 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.
 * 
 * @APPLE_LICENSE_HEADER_END@
 */

/*
 * sslDebug.h - Debugging macros.
 */

#ifndef	_SSL_DEBUG_H_
#define _SSL_DEBUG_H_

#ifdef KERNEL
/* TODO: support secinfo in the kernel */
#define secinfo(x...)
#else /* KERNEL */
#include <utilities/debugging.h>
#endif

#ifndef	NDEBUG
#include <AssertMacros.h>
#endif


#define ssl_secinfo secinfo

#ifndef NDEBUG

/* log changes in handshake state */
#define sslHdskStateDebug(args...)		ssl_secinfo("sslHdskState", ## args)

/* log handshake and alert messages */
#define sslHdskMsgDebug(args...)		ssl_secinfo("sslHdskMsg", ## args)

/* log negotiated handshake parameters */
#define sslLogNegotiateDebug(args...)	ssl_secinfo("sslLogNegotiate", ## args)

/* log received protocol messsages */
#define sslLogRxProtocolDebug(msgType)	ssl_secinfo("sslLogRxProtocol", \
										"---received protoMsg %s", msgType)

/* log resumable session info */
#define sslLogResumSessDebug(args...)	ssl_secinfo("sslResumSession", ## args)

/* log low-level session info in appleSession.c */
#define sslLogSessCacheDebug(args...)	ssl_secinfo("sslSessionCache", ## args)

/* log record-level I/O (SSLRead, SSLWrite) */
#define sslLogRecordIo(args...)			ssl_secinfo("sslRecordIo", ## args)

/* cert-related info */
#define sslCertDebug(args...)			ssl_secinfo("sslCert", ## args)

/* Diffie-Hellman */
#define sslDhDebug(args...)				ssl_secinfo("sslDh", ## args)

/* EAP-FAST PAC-based session resumption */
#define sslEapDebug(args...)			ssl_secinfo("sslEap", ## args)

/* ECDSA */
#define sslEcdsaDebug(args...)			ssl_secinfo("sslEcdsa", ## args)

#else /* NDEBUG */

/*  deployment build */
#define sslHdskStateDebug(args...)
#define sslHdskMsgDebug(args...)
#define sslLogNegotiateDebug(args...)
#define sslLogRxProtocolDebug(msgType)
#define sslLogResumSessDebug(args...)
#define sslLogSessCacheDebug(args...)
#define sslLogRecordIo(args...)
#define sslCertDebug(args...)
#define sslDhDebug(args...)
#define sslEapDebug(args...)
#define sslEcdsaDebug(args...)

#endif	/*
NDEBUG */

#ifdef	NDEBUG

/* all errors logged to stdout for DEBUG config only */
#define sslErrorLog(args...)
#define sslDebugLog(args...)
#define sslDump(d, l)

#else

extern void SSLDump(const unsigned char *data, unsigned long len);

/* extra debug logging of non-error conditions, if SSL_DEBUG is defined */
#if SSL_DEBUG
//#define sslDebugLog(args...)        printf(args)
#define sslDebugLog(args...)        ssl_secinfo("sslDebug", ## args)
#else
#define sslDebugLog(args...)
#endif
/* all errors logged to stdout for DEBUG config only */
//#define sslErrorLog(args...)        printf(args)
#define sslErrorLog(args...)        ssl_secinfo("sslError", ## args)
#define sslDump(d, l)               SSLDump((d), (l))

#endif	/* NDEBUG */


#ifdef	NDEBUG
#define ASSERT(s)
#else
#define ASSERT(s)	check(s)
#endif

#endif	/* _SSL_DEBUG_H_ */