libsecurity_keychain/lib/SecImportExportOpenSSH.h

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