snej@0: //
snej@0: //  MYKey.h
snej@0: //  MYCrypto
snej@0: //
snej@0: //  Created by Jens Alfke on 3/30/09.
snej@0: //  Copyright 2009 Jens Alfke. All rights reserved.
snej@0: //
snej@0: 
snej@0: #import "MYKeychainItem.h"
snej@0: 
snej@0: 
snej@1: @protocol MYEncryption <NSObject>
snej@0: 
snej@1: /** Encrypts data using this key, returning the raw encrypted result. */
snej@1: - (NSData*) encryptData: (NSData*)data;
snej@1: 
snej@1: @end
snej@1: 
snej@1: @protocol MYDecryption <NSObject>
snej@1: 
snej@1: /** Decrypts data using this key, returning the original data. */
snej@1: - (NSData*) decryptData: (NSData*)data;
snej@1: 
snej@1: @end
snej@1: 
snej@1: 
snej@1: 
snej@1: /** Abstract superclass for keys.
snej@1:     Concrete subclasses are MYSymmetricKey and MYPublicKey. */
snej@0: @interface MYKey : MYKeychainItem
snej@0: 
snej@1: /** The key's raw data. */
snej@0: @property (readonly) NSData *keyData;
snej@0: 
snej@0: /** The user-visible name (kSecKeyPrintName) associated with this key in the Keychain.
snej@0:     The user can edit this, so don't expect it to be immutable. */
snej@0: @property (copy) NSString *name;
snej@0: 
snej@0: /** An application-specific string (kSecKeyAlias) associated with this key in the Keychain.
snej@0:     Not visible to or editable by the user.
snej@0:     If you own this key, you can store any associated metadata you like here, although be aware
snej@0:     that it can be read and modified by any other app that can access this key. */
snej@0: @property (copy) NSString *alias;
snej@0: 
snej@0: #if !TARGET_OS_IPHONE
snej@0: /** The user-visible comment (kSecKeyApplicationTag) associated with this key in the Keychain.
snej@0:     The user can edit this, so don't expect it to be immutable. */
snej@0: @property (copy) NSString *comment;
snej@0: #endif
snej@0: 
snej@0: @end
snej@0: 
snej@0: 
snej@0: 
snej@1: @interface MYKey (Expert)
snej@0: 
snej@1: /** Creates a MYKey object for an existing Keychain key reference.
snej@1:     This is abstract -- must be called on a MYSymmetricKey or MYPublicKey, as appropriate. */
snej@1: - (id) initWithKeyRef: (SecKeyRef)keyRef;
snej@1: 
snej@1: /** The Keychain object reference for this key. */
snej@1: @property (readonly) SecKeyRef keyRef;
snej@1: 
snej@1: #if !TARGET_OS_IPHONE
snej@1: /** The underlying CSSM_KEY structure; used with low-level crypto APIs. */
snej@1: @property (readonly) const struct cssm_key* cssmKey;
snej@1: 
snej@1: /** Converts the key into a data blob in one of several standard formats, suitable for storing in
snej@1:     a file or sending over the network.
snej@1:     @param format  The data format: kSecFormatOpenSSL, kSecFormatSSH, kSecFormatBSAFE or kSecFormatSSHv2.
snej@1:     @param withPEM  YES if the data should be encoded in PEM format, which converts into short lines
snej@1:         of printable ASCII characters, suitable for sending in email. */
snej@1: - (NSData*) exportKeyInFormat: (SecExternalFormat)format withPEM: (BOOL)withPEM;
snej@1: #endif
snej@0: 
snej@0: @end