OSX/libsecurity_keychain/lib/SecImportExportOpenSSH.h

   1 /*
   2  * Copyright (c) 2006,2011,2014 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  * SecImportExportOpenSSH.h - support for importing and exporting OpenSSH keys.
  26  *
  27  */
  28
  29 #ifndef _SEC_IMPORT_EXPORT_OPENSSH_H_
  30 #define _SEC_IMPORT_EXPORT_OPENSSH_H_
  31
  32 #include <Security/SecImportExport.h>
  33 #include <security_cdsa_utilities/cssmdata.h>
  34
  35 #ifdef  __cplusplus
  36 extern "C" {
  37 #endif
  38
  39 /*
  40  * Infer PrintName attribute from raw key's 'comment' field.
  41  * Returned string is mallocd and must be freed by caller.
  42  */
  43 extern char *impExpOpensshInferPrintName(
  44         CFDataRef external,
  45         SecExternalItemType externType,
  46         SecExternalFormat externFormat);
  47
  48 /*
  49  * Infer DescriptiveData (i.e., comment) from a SecKeyRef's PrintName
  50  * attribute.
  51  */
  52 extern void impExpOpensshInferDescData(
  53         SecKeyRef keyRef,
  54         CssmOwnedData &descData);
  55
  56 /*
  57  * If cspHand is provided instead of importKeychain, the CSP
  58  * handle MUST be for the CSPDL, not for the raw CSP.
  59  */
  60 extern OSStatus impExpWrappedOpenSSHImport(
  61         CFDataRef                                                       inData,
  62         SecKeychainRef                                          importKeychain, // optional
  63         CSSM_CSP_HANDLE                                         cspHand,                // required
  64         SecItemImportExportFlags                        flags,
  65         const SecKeyImportExportParameters      *keyParams,             // optional
  66         const char                                                      *printName,
  67         CFMutableArrayRef                                       outArray);              // optional, append here
  68
  69 extern OSStatus impExpWrappedOpenSSHExport(
  70         SecKeyRef                                                       secKey,
  71         SecItemImportExportFlags                        flags,
  72         const SecKeyImportExportParameters      *keyParams,             // optional
  73         const CssmData                                          &descData,
  74         CFMutableDataRef                                        outData);               // output appended here
  75
  76 #ifdef  __cplusplus
  77 }
  78 #endif
  79
  80 #endif  /* _SEC_IMPORT_EXPORT_OPENSSH_H_ */