# HG changeset patch
# User snej@snej.local
# Date 1239759292 25200
# Node ID 3568d5fd4b6a1dfe672c7518ac45915b7b8e2157
# Parent 99316197218387db73291e589739fb8d42b7281a
* The build process runs Doxygen only if it's installed (i.e. on the shell search path).
* Added instructions to the README on setting up a named Source Tree for MYUtilities.
* Changed the RSA key size in MYCryptoTest to 2048 and made it a named constant.
diff -r 993161972183 -r 3568d5fd4b6a MYCrypto.xcodeproj/project.pbxproj
--- a/MYCrypto.xcodeproj/project.pbxproj Sun Apr 12 22:16:38 2009 -0700
+++ b/MYCrypto.xcodeproj/project.pbxproj Tue Apr 14 18:34:52 2009 -0700
@@ -289,8 +289,8 @@
outputPaths = (
);
runOnlyForDeploymentPostprocessing = 0;
- shellPath = /bin/csh;
- shellScript = "doxygen |& sed s/Warning/warning/\n";
+ shellPath = /bin/sh;
+ shellScript = "if [ `which doxygen` ]; then\n doxygen 2>&1 | sed s/Warning/warning/\nfi\n";
showEnvVarsInLog = 0;
};
/* End PBXShellScriptBuildPhase section */
diff -r 993161972183 -r 3568d5fd4b6a MYCryptoTest.m
--- a/MYCryptoTest.m Sun Apr 12 22:16:38 2009 -0700
+++ b/MYCryptoTest.m Tue Apr 14 18:34:52 2009 -0700
@@ -17,6 +17,9 @@
#if DEBUG
+
+#define kTestCaseRSAKeySize 2048
+
#pragma mark -
#pragma mark KEYCHAIN:
@@ -224,7 +227,7 @@
RequireTestCase(MYKeychain);
Log(@"Generating key pair...");
- MYPrivateKey *pair = [[MYKeychain defaultKeychain] generateRSAKeyPairOfSize: 512];
+ MYPrivateKey *pair = [[MYKeychain defaultKeychain] generateRSAKeyPairOfSize: kTestCaseRSAKeySize];
MYPublicKey *publicKey = pair.publicKey;
Log(@"...created { %@ , %@ }.", pair, publicKey);
@@ -284,7 +287,7 @@
static void testKeyPairExportWithPrompt(BOOL withPrompt) {
MYKeychain *keychain = [MYKeychain allKeychains];
Log(@"Generating key pair...");
- MYPrivateKey *pair = [keychain generateRSAKeyPairOfSize: 512];
+ MYPrivateKey *pair = [keychain generateRSAKeyPairOfSize: kTestCaseRSAKeySize];
CAssert(pair);
CAssert(pair.keyRef);
CAssert(pair.publicKey.keyRef);
@@ -292,7 +295,7 @@
@try{
NSData *pubKeyData = pair.publicKey.keyData;
- CAssert(pubKeyData.length >= 512/8);
+ CAssert(pubKeyData.length >= kTestCaseRSAKeySize/8);
[pair setName: @"Test KeyPair Label"];
CAssertEqual(pair.name, @"Test KeyPair Label");
#if !TARGET_OS_IPHONE
diff -r 993161972183 -r 3568d5fd4b6a README.textile
--- a/README.textile Sun Apr 12 22:16:38 2009 -0700
+++ b/README.textile Tue Apr 14 18:34:52 2009 -0700
@@ -34,13 +34,27 @@
h3. How To Get It
* "Download the current source code":http://mooseyard.com/hg/hgwebdir.cgi/MYCrypto/archive/tip.zip
-* To check out the source code using "Mercurial":http://selenic.com/mercurial/:
+* or to check out the source code using "Mercurial":http://selenic.com/mercurial/:
@hg clone http://mooseyard.com/hg/hgwebdir.cgi/MYCrypto/ MYCrypto@
* As described above, you'll also need to download or check out MYUtilities and put it in a directory next to MYCrypto.
+* To file or view bug reports, visit "the project tracker page":http://mooseyard.lighthouseapp.com/projects/29227/home.
* Or if you're just looking:
** "Browse the source code":http://mooseyard.com/hg/hgwebdir.cgi/MYCrypto/file/tip
** "Browse the class documentation":Documentation/html/hierarchy.html
+h3. How To Build It
+
+With Xcode, of course. But before the _first_ time you build MYCrypto.xcode, you'll need to tell Xcode where the MYUtilities sources are. You do this by setting up a named 'Source Tree':
+
+# Open Xcode's Preferences panel
+# Click the "Source Trees" icon at the top
+# Click the "+" button to add a new item to the list
+# Fill in the Setting Name as "@MYUtilities@", the Display Name also as "@MYUtilities@", and the Path as the absolute filesystem path to where you downloaded MYUtilities to. _Do not use a "~" in this path!_ The compiler won't understand it and will give you errors.
+
+Now you're golden. From now on you can just open MYCrypto.xcode and press the Build button.
+
+(So far, the MYCrypto project doesn't build anything that's useful to you, like a framework ... just a tiny program that runs the unit-tests. You can add the source files to your own projects to use them.)
+
h2. Overview
The class hierarchy of MYCrypto looks like this:
@@ -63,6 +77,65 @@
(_Italicized_ classes are abstract.)
+h2. Examples
+
+h3. Creating an RSA key-pair
+
+
+MYPrivateKey *keyPair = [[MYKeychain defaultKeychain] generateRSAKeyPairOfSize: 2048];
+
+
+h3. Creating a self-signed identity certificate:
+
+
+NSDictionary *attrs = [NSDictionary dictionaryWithObjectsAndKeys:
+ @"alice", @"Common Name",
+ @"Alice", @"Given Name",
+ @"Lidell", @"Surname",
+ nil];
+MYIdentity *ident = [keyPair createSelfSignedIdentityWithAttributes: attrs];
+
+NSData *certData = ident.certificateData;
+
+
+h3. Signing and encrypting a message:
+
+
+NSData *cleartext = [@"Attack at dawn" dataUsingEncoding: NSUTF8StringEncoding];
+MYEncoder *encoder = [[MYEncoder alloc] init];
+[encoder addSigner: ident];
+[encoder addRecipient: bob];
+[encoder addRecipient: carla];
+[encoder addData: cleartext];
+[encoder finish];
+NSData *ciphertext = encoder.encodedData;
+
+sendMessage(ciphertext);
+
+
+h3. Verifying and decoding a message:
+
+
+NSData *ciphertext = receiveMessage();
+NSError *error;
+MYDecoder *decoder = [[MYDecoder alloc] initWithData: ciphertext error: &error];
+if (!decoder)
+ return NO;
+
+if (!decoder.isSigned)
+ return NO;
+decoder.policy = [MYCertificate X509Policy];
+NSMutableArray *signerCerts = [NSMutableArray array];
+for (MYSigner *signer in decoder.signers) {
+ if (signer.status != kCMSSignerValid) {
+ return NO;
+ [signerCerts addObject: signer.certificate];
+}
+
+NSData *plaintext = decoder.content;
+processMessage(plaintext, signerCerts);
+
+
h2. Current Limitations
h3. First off, the biggest caveat of all: