-/*
- * armor.c - Routines to (de)armor OpenPGP packet streams.
+/**
+ * @file armor.c
+ * @brief Routines to (de)armor OpenPGP packet streams.
+ *
+ * Copyright 2002-2004, 2011 Jonathan McDowell <noodles@earth.li>
+ *
+ * This program is free software: you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License as published by the Free
+ * Software Foundation; version 2 of the License.
*
- * Jonathan McDowell <noodles@earth.li>
+ * This program is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
+ * more details.
*
- * Copyright 2002 Project Purple
+ * You should have received a copy of the GNU General Public License along with
+ * this program. If not, see <https://www.gnu.org/licenses/>.
*/
#include <stdlib.h>
+#include "build-config.h"
+
#include "armor.h"
#include "keystructs.h"
-#include "log.h"
-#include "onak-conf.h"
#include "parsekey.h"
-#include "version.h"
+/**
+ * @brief Line length we'll use for armored output
+ */
#define ARMOR_WIDTH 64
+/**
+ * @brief CRC24 initialisation value
+ */
#define CRC24_INIT 0xb704ceL
+/**
+ * @brief CRC24 polynomial value
+ */
#define CRC24_POLY 0x1864cfbL
/**
} else if (c == 63) {
c = '/';
} else {
- log_assert(c < 64);
+ c = '?';
}
return c;
}
/**
- * @lastoctet: The last octet we got.
- * @curoctet: The current octet we're expecting (0, 1 or 2).
- * @count: The number of octets we've seen.
- * @crc24: A running CRC24 of the data we've seen.
- * @putchar_func: The function to output a character.
- * @ctx: Context for putchar_func.
+ * @brief Holds the context of an ongoing ASCII armor operation
*/
struct armor_context {
+ /** The last octet we got. */
unsigned char lastoctet;
+ /** The current octet we're expecting (0, 1 or 2). */
int curoctet;
+ /** The number of octets we've seen. */
int count;
+ /** A running CRC24 of the data we've seen. */
long crc24;
+ /** The function to output a character. */
int (*putchar_func)(void *ctx, size_t count, void *c);
+ /** Context for putchar_func. */
void *ctx;
};
unsigned char t;
int i;
- log_assert(ctx != NULL);
state = (struct armor_context *) ctx;
switch (state->curoctet++) {
{
int i;
- log_assert(c != NULL);
for (i = 0; i < count; i++) {
armor_putchar_int(ctx, ((char *) c)[i]);
}
/**
- * @lastoctet: The last octet we got.
- * @curoctet: The current octet we're expecting (0, 1 or 2).
- * @count: The number of octets we've seen.
- * @crc24: A running CRC24 of the data we've seen.
- * @putchar_func: The function to output a character.
- * @ctx: Context for putchar_func.
+ * @brief Holds the context of an ongoing ASCII dearmor operation
*/
struct dearmor_context {
+ /** The last octet we got. */
unsigned char lastoctet;
+ /** The current octet we're expecting (0, 1 or 2). */
int curoctet;
+ /** The number of octets we've seen. */
int count;
+ /** A running CRC24 of the data we've seen. */
long crc24;
+ /** The function to get the next character. */
int (*getchar_func)(void *ctx, size_t count, void *c);
+ /** Context for getchar_func. */
void *ctx;
};
unsigned char tmpc;
int i;
- log_assert(ctx != NULL);
state = (struct dearmor_context *) ctx;
*c = 0;
return rc;
}
-/**
- * armor_openpgp_stream - Takes a list of OpenPGP packets and armors it.
- * @putchar_func: The function to output the next armor character.
- * @ctx: The context pointer for putchar_func.
- * @packets: The list of packets to output.
- *
- * This function ASCII armors a list of OpenPGP packets and outputs it
- * using putchar_func.
- */
int armor_openpgp_stream(int (*putchar_func)(void *ctx, size_t count,
void *c),
void *ctx,
/*
* Print armor header
*/
- putchar_func(ctx, sizeof("-----BEGIN PGP PUBLIC KEY BLOCK-----\n") - 1,
- (unsigned char *) "-----BEGIN PGP PUBLIC KEY BLOCK-----\n");
- putchar_func(ctx, sizeof("Version: onak " ONAK_VERSION "\n\n") - 1,
- (unsigned char *) "Version: onak " ONAK_VERSION "\n\n");
-
+ putchar_func(ctx, sizeof("-----BEGIN PGP PUBLIC KEY BLOCK-----\n\n") - 1,
+ (unsigned char *) "-----BEGIN PGP PUBLIC KEY BLOCK-----\n\n");
+
armor_init(&armor_ctx);
armor_ctx.putchar_func = putchar_func;
armor_ctx.ctx = ctx;
return 0;
}
-/**
- * dearmor_openpgp_stream - Reads & decodes an ACSII armored OpenPGP msg.
- * @getchar_func: The function to get the next character from the stream.
- * @ctx: The context pointer for getchar_func.
- * @packets: The list of packets.
- *
- * This function uses getchar_func to read characters from an ASCII
- * armored OpenPGP stream and outputs the data as a linked list of
- * packets.
- */
int dearmor_openpgp_stream(int (*getchar_func)(void *ctx, size_t count,
void *c),
void *ctx,