1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/MYKeyPair.h	Sat Apr 04 20:42:03 2009 -0700
     1.3 @@ -0,0 +1,54 @@
     1.4 +//
     1.5 +//  KeyPair.h
     1.6 +//  MYCrypto
     1.7 +//
     1.8 +//  Created by Jens Alfke on 3/21/09.
     1.9 +//  Copyright 2009 Jens Alfke. All rights reserved.
    1.10 +//
    1.11 +
    1.12 +#import "MYPublicKey.h"
    1.13 +
    1.14 +
    1.15 +/** A key-pair consisting of a public and a private key.
    1.16 +    Can be used for signing and decrypting, as well as the inherited encrypting/verifying. */
    1.17 +@interface MYKeyPair : MYPublicKey <MYDecryption>
    1.18 +{
    1.19 +    SecKeyRef _privateKey;
    1.20 +}
    1.21 +
    1.22 +/** Creates a MYKeyPair object from existing Keychain key references. */
    1.23 +- (id) initWithPublicKeyRef: (SecKeyRef)publicKey privateKeyRef: (SecKeyRef)privateKey;
    1.24 +
    1.25 +#if !TARGET_OS_IPHONE
    1.26 +/** Exports the private key as a data blob, so that it can be stored as a backup, or transferred
    1.27 +    to another computer. Since the key is sensitive, it must be exported in encrypted form
    1.28 +    using a user-chosen passphrase. This method will display a standard alert panel, run by
    1.29 +    the Security agent, that prompts the user to enter a new passphrase for encrypting the key.
    1.30 +    The same passphrase must be re-entered when importing the key from the data blob.
    1.31 +    @param format  The data format: kSecFormatOpenSSL, kSecFormatSSH, kSecFormatBSAFE or kSecFormatSSHv2.
    1.32 +    @param withPEM  YES if the data should be encoded in PEM format, which converts into short lines
    1.33 +        of printable ASCII characters, suitable for sending in email.
    1.34 +    @param alertTitle  An optional title for the alert panel. (Currently ignored by the OS?)
    1.35 +    @param prompt  An optional prompt message to display in the alert panel. */
    1.36 +- (NSData*) exportPrivateKeyInFormat: (SecExternalFormat)format
    1.37 +                             withPEM: (BOOL)withPEM
    1.38 +                          alertTitle: (NSString*)title
    1.39 +                         alertPrompt: (NSString*)prompt;
    1.40 +
    1.41 +/** A convenient shorthand for the full exportPrivateKeyInFormat... method.
    1.42 +    Uses OpenSSL format, wrapped with PEM, and default title and prompt for the alert. */
    1.43 +- (NSData*) exportPrivateKey;
    1.44 +#endif
    1.45 +
    1.46 +/** The underlying Keychain key reference for the private key. */
    1.47 +@property (readonly) SecKeyRef privateKeyRef;
    1.48 +
    1.49 +/** Decrypts data that was encrypted using the public key. */
    1.50 +- (NSData*) decryptData: (NSData*)data;
    1.51 +
    1.52 +/** Generates a signature of data, using the private key.
    1.53 +    The resulting signature can be verified using the matching MYPublicKey's
    1.54 +    verifySignature:ofData: method. */
    1.55 +- (NSData*) signData: (NSData*)data;
    1.56 +
    1.57 +@end