Added a few comments. That is all.
5 // Created by Jens Alfke on 6/2/09.
6 // Copyright 2009 Jens Alfke. All rights reserved.
9 #import <Foundation/Foundation.h>
10 @class MYCertificateName, MYCertificate, MYIdentity, MYPublicKey, MYPrivateKey, MYOID;
12 /** A parsed X.509 certificate; provides access to the names and metadata. */
13 @interface MYCertificateInfo : NSObject
19 /** Initialize by parsing X.509 certificate data.
20 (More commonly you'll get an instance via MYCertificate's 'info' property.) */
21 - (id) initWithCertificateData: (NSData*)data error: (NSError**)outError;
23 /** The date/time at which the certificate first becomes valid. */
24 @property (retain, readonly) NSDate *validFrom;
26 /** The date/time at which the certificate expires. */
27 @property (retain, readonly) NSDate *validTo;
29 /** Information about the identity of the owner of this certificate. */
30 @property (readonly) MYCertificateName *subject;
32 /** Information about the identity that signed/authorized this certificate. */
33 @property (readonly) MYCertificateName *issuer;
35 /** Returns YES if the issuer is the same as the subject. (Aka a "self-signed" certificate.) */
36 @property (readonly) BOOL isRoot;
42 /** A mutable, unsigned certificate that can be filled out and then signed by the issuer.
43 Used to generate an identity certificate for a key-pair. */
44 @interface MYCertificateRequest : MYCertificateInfo
47 MYPublicKey *_publicKey;
50 /** Initializes a blank instance which can be used to create a new certificate.
51 The certificate will not contain anything yet other than the public key.
52 The desired attributes should be set, and then the -selfSignWithPrivateKey:error method called. */
53 - (id) initWithPublicKey: (MYPublicKey*)pubKey;
55 /** The date/time at which the certificate first becomes valid. Settable. */
56 @property (retain) NSDate *validFrom;
58 /** The date/time at which the certificate expires. Settable */
59 @property (retain) NSDate *validTo;
61 /** Encodes the certificate request in X.509 format -- this is NOT a certificate!
62 It has to be sent to a Certificate Authority to be signed.
63 If you want to generate a self-signed certificate, use one of the self-signing methods instead. */
64 - (NSData*) requestData: (NSError**)outError;
66 /** Signs the certificate using the given private key, which must be the counterpart of the
67 public key stored in the certificate, and returns the encoded certificate data.
68 The subject attributes will be copied to the issuer attributes.
69 If no valid date range has been set yet, it will be set to a range of one year starting from
71 A unique serial number based on the current time will be set. */
72 - (NSData*) selfSignWithPrivateKey: (MYPrivateKey*)privateKey error: (NSError**)outError;
74 /** Signs the certificate using the given private key, which must be the counterpart of the
75 public key stored in the certificate; adds the certificate to the keychain;
76 and returns a MYIdentity representing the paired certificate and private key. */
77 - (MYIdentity*) createSelfSignedIdentityWithPrivateKey: (MYPrivateKey*)privateKey
78 error: (NSError**)outError;
83 /** An X.509 Name structure, describing the subject or issuer of a certificate.
84 The properties are settable only if this instance belongs to a MYCertificateRequest;
85 otherwise trying to set them will raise an exception. */
86 @interface MYCertificateName : NSObject
92 /** The "common name" (nickname, whatever). */
93 @property (copy) NSString *commonName;
95 /** The given/first name. */
96 @property (copy) NSString *givenName;
98 /** The surname / last name / family name. */
99 @property (copy) NSString *surname;
101 /** A description. */
102 @property (copy) NSString *nameDescription;
104 /** The raw email address. */
105 @property (copy) NSString *emailAddress;
107 /** Lower-level accessor that returns the value associated with the given OID. */
108 - (NSString*) stringForOID: (MYOID*)oid;
110 /** Lower-level accessor that sets the value associated with the given OID. */
111 - (void) setString: (NSString*)value forOID: (MYOID*)oid;