SecurityTool/macOS/keychain_utilities.h

   1 /*
   2  * Copyright (c) 2003-2009,2019 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  * keychain_utilities.h
  24  */
  25
  26 #ifndef _KEYCHAIN_UTILITIES_H_
  27 #define _KEYCHAIN_UTILITIES_H_ 1
  28
  29 #include <Security/SecKeychain.h>
  30
  31 #include <stdio.h>
  32 #include <CoreFoundation/CFData.h>
  33 #include <CoreFoundation/CFDictionary.h>
  34
  35 #ifdef __cplusplus
  36 extern "C" {
  37 #endif
  38
  39 /* Open a given named keychain. */
  40 extern SecKeychainRef keychain_open(const char *name);
  41
  42 /* Return either NULL if argc is 0, or a SecKeychainRef if argc is 1 or a CFArrayRef of SecKeychainRefs if argc is greater than 1. */
  43 extern CFTypeRef keychain_create_array(int argc, char * const *argv);
  44
  45 extern int parse_fourcharcode(const char *name, UInt32 *code);
  46
  47 extern int print_keychain_name(FILE *stream, SecKeychainRef keychain);
  48
  49 extern int print_keychain_item_attributes(FILE *stream, SecKeychainItemRef item, Boolean show_data, Boolean show_raw_data, Boolean show_acl, Boolean interactive);
  50
  51 extern void print_cfstring(FILE *stream, CFStringRef string);
  52
  53 extern void print_buffer(FILE *stream, size_t length, const void *data);
  54
  55 extern void print_buffer_pem(FILE *stream, const char *headerString, size_t length, const void *data);
  56
  57 extern void print_uint32(FILE* stream, uint32 n);
  58
  59 extern unsigned char hexToValue(char c, char *error);
  60 extern unsigned char hexValue(char c);
  61
  62 extern bool convertHex(const char *hexString, uint8_t **outData, size_t *outLength);
  63
  64 extern void fromHex(const char *hexDigits, CSSM_DATA *data);
  65
  66 extern CFDataRef cfFromHex(CFStringRef hex);
  67
  68 extern CFStringRef cfToHex(CFDataRef bin);
  69
  70 extern CFDictionaryRef makeCFDictionaryFromData(CFDataRef data);
  71
  72 extern void GetCStringFromCFString(CFStringRef cfstring, char** cstr, size_t* len);
  73
  74 extern void print_partition_id_list(FILE *stream, CFStringRef description);
  75
  76 extern void safe_CFRelease(void CF_CONSUMED *cfTypeRefPtr);
  77
  78 extern void check_obsolete_keychain(const char *kcName);
  79
  80 extern char* prompt_password(const char* keychainName);
  81
  82 #ifdef __cplusplus
  83 }
  84 #endif
  85
  86 #endif /*  _KEYCHAIN_UTILITIES_H_ */