[apple/security.git] / OSX / libsecurity_mds / lib / MDSAttrUtils.h

/*
 * Copyright (c) 2000-2001,2011,2014 Apple 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:      MDSAttrUtils.h

   Contains:  Stateless functions used by MDSAttrParser.  

   Copyright (c) 2001,2011,2014 Apple Inc. All Rights Reserved.
*/

#ifndef _MDS_ATTR_UTILS_H_
#define _MDS_ATTR_UTILS_H_  1

#include <Security/cssmtype.h>
#include <security_utilities/debugging.h>
#include <CoreFoundation/CoreFoundation.h>
#include "MDSAttrStrings.h"
#include "MDSSession.h"

/* log parsing events */
#define MPDebug(args...)	secinfo("MDS_Parse", ## args)

/* log scanning events */
#define MSDebug(args...)	secinfo("MDS_Scan", ## args)

/*
 * I can't believe that CFRelease does not do this...
 */
#define CF_RELEASE(c)	if(c != NULL) { CFRelease(c); c = NULL; }

namespace Security
{

/*
 * Fill in one CSSM_DB_ATTRIBUTE_DATA with specified data, type and attribute name.
 * CSSM_DB_ATTRIBUTE_DATA.Value and its referent are new[]'d and copied.
 * Assumes:
 *   -- AttributeNameFormat = CSSM_DB_ATTRIBUTE_NAME_AS_STRING
 */
extern void MDSRawValueToDbAttr(
	const void *value,
	size_t len,
	CSSM_DB_ATTRIBUTE_FORMAT attrFormat,	// CSSM_DB_ATTRIBUTE_FORMAT_STRING, etc.
	const char *attrName,
	CSSM_DB_ATTRIBUTE_DATA &attr,
	uint32 numValues = 1);

/*
 * Free data new[]'d in the above function.
 */
extern void MDSFreeDbRecordAttrs(
	CSSM_DB_ATTRIBUTE_DATA 	*attrs,
	unsigned				numAttrs);


/* safely get a new[]'d C string from a CFString */
char *MDSCFStringToCString(
	CFStringRef cfStr);

/* copy a new[]'d C string from a C string */
char *MDSCopyCstring(
	const char *inStr);

/* 
 * Given a CFTypeRef which is either a CFString or a CFNumber, do our best to 
 * convert it to a uint32. If it's a CFString, we'll use a MDSNameValuePair
 * to convert it. CFStrings expressed as decimal numbers are also converted
 * properly. (MAYBE we'll convert hex strings too...TBD...)
 * Returns true if conversion was successful.
 */
bool MDSCfTypeToUInt32(
	CFTypeRef cfValue,
	const MDSNameValuePair *nameValues,	// optional for converting strings to numbers
	const char *key,					// for debug logging only 
	uint32 &value,						// RETURNED
    size_t &valueLen);					// RETURNED

/*
 * Insert a record, defined by a CSSM_DB_ATTRIBUTE_DATA array, into specified
 * DL and DB. Returns true on success.
 */
bool MDSInsertRecord(
	const CSSM_DB_ATTRIBUTE_DATA 	*inAttr,
	unsigned						numAttrs,
	CSSM_DB_RECORDTYPE				recordType,
	MDSSession						&dl,
	CSSM_DB_HANDLE					dbHand);

/*
 * Convert a number expressed as a CFString to a uint32 using the specified
 * name/value conversion table. The string may have multiple fields from that
 * table, ORd together in normal C syntax. Like
 *
 *      CSSM_SERVICE_CSP | CSSM_SERVICE_DL
 */
CSSM_RETURN MDSStringToUint32(
	CFStringRef str, 
	const MDSNameValuePair *table,
	uint32 &value);					// RETURNED


} // end namespace Security

#endif	/* _MDS_ATTR_UTILS_H_ */
Commit	Line	Data
b1ab9ed8	1	/*
d8f41ccd	2	* Copyright (c) 2000-2001,2011,2014 Apple Inc. All Rights Reserved.
b1ab9ed8 A	3	*
	4	* The contents of this file constitute Original Code as defined in and are
	5	* subject to the Apple Public Source License Version 1.2 (the 'License').
	6	* You may not use this file except in compliance with the License. Please obtain
	7	* a copy of the License at http://www.apple.com/publicsource and read it before
	8	* using this file.
	9	*
	10	* This Original Code and all software distributed under the License are
	11	* distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS
	12	* OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES, INCLUDING WITHOUT
	13	* LIMITATION, ANY WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
	14	* PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT. Please see the License for the
	15	* specific language governing rights and limitations under the License.
	16	*/
	17
	18
	19	/*
	20	File: MDSAttrUtils.h
	21
	22	Contains: Stateless functions used by MDSAttrParser.
	23
d8f41ccd	24	Copyright (c) 2001,2011,2014 Apple Inc. All Rights Reserved.
b1ab9ed8 A	25	*/
	26
	27	#ifndef _MDS_ATTR_UTILS_H_
	28	#define _MDS_ATTR_UTILS_H_ 1
	29
	30	#include <Security/cssmtype.h>
	31	#include <security_utilities/debugging.h>
	32	#include <CoreFoundation/CoreFoundation.h>
	33	#include "MDSAttrStrings.h"
	34	#include "MDSSession.h"
	35
	36	/* log parsing events */
fa7225c8	37	#define MPDebug(args...) secinfo("MDS_Parse", ## args)
b1ab9ed8 A	38
b1ab9ed8 A	39	/* log scanning events */
fa7225c8	40	#define MSDebug(args...) secinfo("MDS_Scan", ## args)
b1ab9ed8 A	41
	42	/*
	43	* I can't believe that CFRelease does not do this...
	44	*/
	45	#define CF_RELEASE(c) if(c != NULL) { CFRelease(c); c = NULL; }
	46
	47	namespace Security
	48	{
	49
	50	/*
	51	* Fill in one CSSM_DB_ATTRIBUTE_DATA with specified data, type and attribute name.
	52	* CSSM_DB_ATTRIBUTE_DATA.Value and its referent are new[]'d and copied.
	53	* Assumes:
	54	* -- AttributeNameFormat = CSSM_DB_ATTRIBUTE_NAME_AS_STRING
	55	*/
	56	extern void MDSRawValueToDbAttr(
	57	const void *value,
	58	size_t len,
	59	CSSM_DB_ATTRIBUTE_FORMAT attrFormat, // CSSM_DB_ATTRIBUTE_FORMAT_STRING, etc.
	60	const char *attrName,
	61	CSSM_DB_ATTRIBUTE_DATA &attr,
	62	uint32 numValues = 1);
	63
	64	/*
	65	* Free data new[]'d in the above function.
	66	*/
	67	extern void MDSFreeDbRecordAttrs(
	68	CSSM_DB_ATTRIBUTE_DATA *attrs,
	69	unsigned numAttrs);
	70
	71
	72	/* safely get a new[]'d C string from a CFString */
	73	char *MDSCFStringToCString(
	74	CFStringRef cfStr);
	75
	76	/* copy a new[]'d C string from a C string */
	77	char *MDSCopyCstring(
	78	const char *inStr);
	79
	80	/*
	81	* Given a CFTypeRef which is either a CFString or a CFNumber, do our best to
	82	* convert it to a uint32. If it's a CFString, we'll use a MDSNameValuePair
	83	* to convert it. CFStrings expressed as decimal numbers are also converted
	84	* properly. (MAYBE we'll convert hex strings too...TBD...)
	85	* Returns true if conversion was successful.
	86	*/
	87	bool MDSCfTypeToUInt32(
	88	CFTypeRef cfValue,
	89	const MDSNameValuePair *nameValues, // optional for converting strings to numbers
	90	const char *key, // for debug logging only
	91	uint32 &value, // RETURNED
	92	size_t &valueLen); // RETURNED
	93
	94	/*
	95	* Insert a record, defined by a CSSM_DB_ATTRIBUTE_DATA array, into specified
	96	* DL and DB. Returns true on success.
	97	*/
	98	bool MDSInsertRecord(
	99	const CSSM_DB_ATTRIBUTE_DATA *inAttr,
	100	unsigned numAttrs,
	101	CSSM_DB_RECORDTYPE recordType,
	102	MDSSession &dl,
	103	CSSM_DB_HANDLE dbHand);
	104
105	/*
106	* Convert a number expressed as a CFString to a uint32 using the specified
107	* name/value conversion table. The string may have multiple fields from that
108	* table, ORd together in normal C syntax. Like
109	*
110	* CSSM_SERVICE_CSP \| CSSM_SERVICE_DL
111	*/
112	CSSM_RETURN MDSStringToUint32(
113	CFStringRef str,
114	const MDSNameValuePair *table,
115	uint32 &value); // RETURNED
116
117
118	} // end namespace Security
119
120	#endif /* _MDS_ATTR_UTILS_H_ */