armor.c

   1 /*
   2  * armor.c - Routines to (de)armor OpenPGP packet streams.
   3  *
   4  * Jonathan McDowell <noodles@earth.li>
   5  *
   6  * Copyright 2002 Project Purple
   7  *
   8  * $Id: armor.c,v 1.5 2003/06/04 20:57:06 noodles Exp $
   9  */
  10
  11 #include <assert.h>
  12 #include <stdlib.h>
  13
  14 #include "armor.h"
  15 #include "keystructs.h"
  16 #include "onak-conf.h"
  17 #include "parsekey.h"
  18
  19 #define ARMOR_WIDTH 64
  20
  21 #define CRC24_INIT 0xb704ceL
  22 #define CRC24_POLY 0x1864cfbL
  23
  24 /**
  25  *
  26  */
  27 static unsigned char encode64(unsigned char c) {
  28         if (c <= 25) {
  29                 c += 'A';
  30         } else if (c >= 26 && c <= 51) {
  31                 c += 'a' - 26;
  32         } else if (c >= 52 && c <= 61) {
  33                 c += '0' - 52;
  34         } else if (c == 62) {
  35                 c = '+';
  36         } else if (c == 63) {
  37                 c = '/';
  38         } else {
  39                 assert(c < 64);
  40         }
  41
  42         return c;
  43 }
  44
  45 /**
  46  *
  47  */
  48 static unsigned char decode64(unsigned char c) {
  49         if (c >= 'A' && c <= 'Z') {
  50                 c -= 'A';
  51         } else if (c >= 'a' && c <= 'z') {
  52                 c -= 'a' - 26;
  53         } else if (c >= '0' && c <= '9') {
  54                 c -= '0' - 52;
  55         } else if (c == '+') {
  56                 c = 62;
  57         } else if (c == '/') {
  58                 c = 63;
  59         } else if (c == '=' || c == '-') {
  60                 c = 64;
  61         } else {
  62                 c = 65;
  63         }
  64
  65         return c;
  66 }
  67
  68 /**
  69  *      @lastoctet: The last octet we got.
  70  *      @curoctet: The current octet we're expecting (0, 1 or 2).
  71  *      @count: The number of octets we've seen.
  72  *      @crc24: A running CRC24 of the data we've seen.
  73  *      @putchar_func: The function to output a character.
  74  *      @ctx: Context for putchar_func.
  75  */
  76 struct armor_context {
  77         unsigned char lastoctet;
  78         int curoctet;
  79         int count;
  80         long crc24;
  81         int (*putchar_func)(void *ctx, size_t count, unsigned char *c);
  82         void *ctx;
  83 };
  84
  85 static void armor_init(struct armor_context *ctx)
  86 {
  87         ctx->curoctet = 0;
  88         ctx->lastoctet = 0;
  89         ctx->count = 0;
  90         ctx->crc24 = CRC24_INIT;
  91 }
  92
  93 static void armor_finish(struct armor_context *state)
  94 {
  95         unsigned char c;
  96
  97         switch (state->curoctet++) {
  98         case 0:
  99                 break;
 100         case 1:
 101                 c = encode64((state->lastoctet & 3) << 4);
 102                 state->putchar_func(state->ctx, 1, &c);
 103                 state->putchar_func(state->ctx, 1, (unsigned char *) "=");
 104                 state->putchar_func(state->ctx, 1, (unsigned char *) "=");
 105                 break;
 106         case 2:
 107                 c = encode64((state->lastoctet & 0xF) << 2);
 108                 state->putchar_func(state->ctx, 1, &c);
 109                 state->putchar_func(state->ctx, 1, (unsigned char *) "=");
 110                 break;
 111         }
 112
 113         state->crc24 &= 0xffffffL;
 114         state->putchar_func(state->ctx, 1, (unsigned char *) "\n");
 115         state->putchar_func(state->ctx, 1, (unsigned char *) "=");
 116         c = encode64(state->crc24 >> 18);
 117         state->putchar_func(state->ctx, 1, &c);
 118         c = encode64((state->crc24 >> 12) & 0x3F);
 119         state->putchar_func(state->ctx, 1, &c);
 120         c = encode64((state->crc24 >> 6) & 0x3F);
 121         state->putchar_func(state->ctx, 1, &c);
 122         c = encode64(state->crc24 & 0x3F);
 123         state->putchar_func(state->ctx, 1, &c);
 124         state->putchar_func(state->ctx, 1, (unsigned char *) "\n");
 125
 126 }
 127
 128
 129 static int armor_putchar_int(void *ctx, unsigned char c)
 130 {
 131         struct armor_context *state;
 132         unsigned char t;
 133         int i;
 134
 135         assert(ctx != NULL);
 136         state = (struct armor_context *) ctx;
 137
 138         switch (state->curoctet++) {
 139         case 0:
 140                 t = encode64(c >> 2);
 141                 state->putchar_func(state->ctx, 1, &t);
 142                 state->count++;
 143                 break;
 144         case 1:
 145                 t = encode64(((state->lastoctet & 3) << 4) + (c >> 4));
 146                 state->putchar_func(state->ctx, 1, &t);
 147                 state->count++;
 148                 break;
 149         case 2:
 150                 t = encode64(((state->lastoctet & 0xF) << 2) + (c >> 6));
 151                 state->putchar_func(state->ctx, 1, &t);
 152                 t = encode64(c & 0x3F);
 153                 state->putchar_func(state->ctx, 1, &t);
 154                 state->count += 2;
 155                 break;
 156         }
 157         state->curoctet %= 3;
 158         state->lastoctet = c;
 159
 160         state->crc24 ^= c << 16;
 161         for (i = 0; i < 8; i++) {
 162                 state->crc24 <<= 1;
 163                 if (state->crc24 & 0x1000000) {
 164                         state->crc24 ^= CRC24_POLY;
 165                 }
 166         }
 167
 168         if ((state->count % ARMOR_WIDTH) == 0) {
 169                 state->putchar_func(state->ctx, 1, (unsigned char *) "\n");
 170         }
 171
 172         return 0;
 173 }
 174
 175
 176 static int armor_putchar(void *ctx, size_t count, unsigned char *c)
 177 {
 178         int i;
 179
 180         for (i = 0; i < count; i++) {
 181                 armor_putchar_int(ctx, c[i]);
 182         }
 183
 184         return 0;
 185 }
 186
 187 /**
 188  *      @lastoctet: The last octet we got.
 189  *      @curoctet: The current octet we're expecting (0, 1 or 2).
 190  *      @count: The number of octets we've seen.
 191  *      @crc24: A running CRC24 of the data we've seen.
 192  *      @putchar_func: The function to output a character.
 193  *      @ctx: Context for putchar_func.
 194  */
 195 struct dearmor_context {
 196         unsigned char lastoctet;
 197         int curoctet;
 198         int count;
 199         long crc24;
 200         int (*getchar_func)(void *ctx, size_t count, unsigned char *c);
 201         void *ctx;
 202 };
 203
 204 static void dearmor_init(struct dearmor_context *ctx)
 205 {
 206         ctx->curoctet = 0;
 207         ctx->lastoctet = 0;
 208         ctx->count = 0;
 209         ctx->crc24 = CRC24_INIT;
 210 }
 211
 212 static void dearmor_finish(struct dearmor_context *state)
 213 {
 214         // Check the checksum,
 215
 216         state->crc24 &= 0xffffffL;
 217 //      state->putchar_func(state->ctx, '\n');
 218 //      state->putchar_func(state->ctx, '=');
 219 //      state->putchar_func(state->ctx, encode64(state->crc24 >> 18));
 220 //      state->putchar_func(state->ctx, encode64((state->crc24 >> 12) & 0x3F));
 221 //      state->putchar_func(state->ctx, encode64((state->crc24 >> 6) & 0x3F));
 222 //      state->putchar_func(state->ctx, encode64(state->crc24 & 0x3F));
 223
 224 }
 225
 226
 227 static int dearmor_getchar(void *ctx, unsigned char *c)
 228 {
 229         struct dearmor_context *state;
 230         unsigned char tmpc;
 231         int i;
 232
 233         assert(ctx != NULL);
 234         state = (struct dearmor_context *) ctx;
 235         *c = 0;
 236
 237         tmpc = 65;
 238         while (tmpc == 65) {
 239                 state->getchar_func(state->ctx, 1, &tmpc);
 240                 tmpc = decode64(tmpc);
 241         }
 242
 243         if (tmpc != 64) {
 244                 switch (state->curoctet++) {
 245                 case 0:
 246                         state->lastoctet = tmpc;
 247                         tmpc = 65;
 248                         while (tmpc == 65) {
 249                                 state->getchar_func(state->ctx, 1, &tmpc);
 250                                 tmpc = decode64(tmpc);
 251                         }
 252                         *c = (state->lastoctet << 2) + (tmpc >> 4);
 253                         break;
 254                 case 1:
 255                         *c = ((state->lastoctet & 0xF) << 4) + (tmpc >> 2);
 256                         break;
 257                 case 2:
 258                         *c = ((state->lastoctet & 3) << 6) + tmpc;
 259                         break;
 260                 }
 261
 262                 state->curoctet %= 3;
 263                 state->lastoctet = tmpc;
 264                 state->count++;
 265
 266                 state->crc24 ^= *c << 16;
 267                 for (i = 0; i < 8; i++) {
 268                         state->crc24 <<= 1;
 269                         if (state->crc24 & 0x1000000) {
 270                                 state->crc24 ^= CRC24_POLY;
 271                         }
 272                 }
 273         }
 274
 275         return (tmpc == 64);
 276 }
 277
 278 static int dearmor_getchar_c(void *ctx, size_t count, unsigned char *c)
 279 {
 280         int i, rc = 0;
 281
 282         for (i = 0; i < count && rc == 0; i++) {
 283                 rc = dearmor_getchar(ctx, &c[i]);
 284         }
 285
 286         return rc;
 287 }
 288
 289 /**
 290  *      armor_openpgp_stream - Takes a list of OpenPGP packets and armors it.
 291  *      @putchar_func: The function to output the next armor character.
 292  *      @ctx: The context pointer for putchar_func.
 293  *      @packets: The list of packets to output.
 294  *
 295  *      This function ASCII armors a list of OpenPGP packets and outputs it
 296  *      using putchar_func.
 297  */
 298 int armor_openpgp_stream(int (*putchar_func)(void *ctx, size_t count,
 299                                                 unsigned char *c),
 300                                 void *ctx,
 301                                 struct openpgp_packet_list *packets)
 302 {
 303         struct armor_context armor_ctx;
 304
 305         /*
 306          * Print armor header
 307          */
 308         putchar_func(ctx, sizeof("-----BEGIN PGP PUBLIC KEY BLOCK-----\n") - 1,
 309                 (unsigned char *) "-----BEGIN PGP PUBLIC KEY BLOCK-----\n");
 310         putchar_func(ctx, sizeof("Version: onak " VERSION "\n\n") - 1,
 311                 (unsigned char *) "Version: onak " VERSION "\n\n");
 312
 313         armor_init(&armor_ctx);
 314         armor_ctx.putchar_func = putchar_func;
 315         armor_ctx.ctx = ctx;
 316         write_openpgp_stream(armor_putchar, &armor_ctx, packets);
 317         armor_finish(&armor_ctx);
 318
 319         /*
 320          * Print armor footer
 321          */
 322         putchar_func(ctx, sizeof("-----END PGP PUBLIC KEY BLOCK-----\n") - 1,
 323                 (unsigned char *) "-----END PGP PUBLIC KEY BLOCK-----\n");
 324
 325         return 0;
 326 }
 327
 328 /**
 329  *      dearmor_openpgp_stream - Reads & decodes an ACSII armored OpenPGP msg.
 330  *      @getchar_func: The function to get the next character from the stream.
 331  *      @ctx: The context pointer for getchar_func.
 332  *      @packets: The list of packets.
 333  *
 334  *      This function uses getchar_func to read characters from an ASCII
 335  *      armored OpenPGP stream and outputs the data as a linked list of
 336  *      packets.
 337  */
 338 int dearmor_openpgp_stream(int (*getchar_func)(void *ctx, size_t count,
 339                                                 unsigned char *c),
 340                                 void *ctx,
 341                                 struct openpgp_packet_list **packets)
 342 {
 343         struct dearmor_context dearmor_ctx;
 344         unsigned char curchar;
 345         int state = 0;
 346         int count = 0;
 347
 348         /*
 349          * Look for armor header. We want "-----BEGIN.*\n", then some headers
 350          * with :s in them, then a blank line, then the data.
 351          */
 352         state = 1;
 353         while (state != 4 && !getchar_func(ctx, 1, &curchar)) {
 354                 switch (state) {
 355                         case 0:
 356                                 if (curchar == '\n') {
 357                                         count = 0;
 358                                         state = 1;
 359                                 }
 360                                 break;
 361                         case 1:
 362                                 if (curchar == '-') {
 363                                         count++;
 364                                         if (count == 5) {
 365                                                 state = 2;
 366                                         }
 367                                 } else if (curchar != '\n') {
 368                                         state = 0;
 369                                 }
 370                                 break;
 371                         case 2:
 372                                 if (curchar == 'B') {
 373                                         count = 0;
 374                                         state = 3;
 375                                 } else {
 376                                         state = 0;
 377                                 }
 378                                 break;
 379                         case 3:
 380                                 if (curchar == '\n') {
 381                                         count++;
 382                                         if (count == 2) {
 383                                                 state = 4;
 384                                         }
 385                                 } else if (curchar != '\r') {
 386                                         count = 0;
 387                                 }
 388                                 break;
 389                 }
 390         }
 391
 392         if (state == 4) {
 393                 dearmor_init(&dearmor_ctx);
 394                 dearmor_ctx.getchar_func = getchar_func;
 395                 dearmor_ctx.ctx = ctx;
 396                 read_openpgp_stream(dearmor_getchar_c, &dearmor_ctx, packets);
 397                 dearmor_finish(&dearmor_ctx);
 398                 // TODO: Look for armor footer
 399         }
 400
 401         return 0;
 402 }