Add ctags/cscope files to .gitignore + clean rule

[onak.git] / armor.c

diff --git a/armor.c b/armor.c
index 6bb77d8d7406376c5f4abcf5b80b173fc7356905..9b61b1acde9ce17832907cfae5a8302771b4089a 100644 (file)
--- a/armor.c
+++ b/armor.c
@@ -1,23 +1,43 @@
-/*
- * 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>

  *
  *

- * 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.

  *
  *

- * Copyright 2002 Project Purple
+ * 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.
+ *
+ * You should have received a copy of the GNU General Public License along with
+ * this program; if not, write to the Free Software Foundation, Inc., 51
+ * Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.

  */
 
 #include <stdlib.h>
 
 #include "armor.h"
  */
 
 #include <stdlib.h>
 
 #include "armor.h"

-#include "config.h"

 #include "keystructs.h"
 #include "keystructs.h"

-#include "log.h"

 #include "onak-conf.h"
 #include "parsekey.h"
 #include "onak-conf.h"
 #include "parsekey.h"

+#include "version.h"

 
 

+/**
+ * @brief Line length we'll use for armored output
+ */

 #define ARMOR_WIDTH 64
 
 #define ARMOR_WIDTH 64
 

+/**
+ * @brief CRC24 initialisation value
+ */

 #define CRC24_INIT 0xb704ceL
 #define CRC24_INIT 0xb704ceL

+/**
+ * @brief CRC24 polynomial value
+ */

 #define CRC24_POLY 0x1864cfbL
 
 /**
 #define CRC24_POLY 0x1864cfbL
 
 /**


@@ -35,7 +55,7 @@ static unsigned char encode64(unsigned char c) {
        } else if (c == 63) {
                c = '/';
        } else {
        } else if (c == 63) {
                c = '/';
        } else {

-               log_assert(c < 64);
+               c = '?';

        }
 
        return c;
        }
 
        return c;


@@ -65,19 +85,20 @@ static unsigned char decode64(unsigned char 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 {
  */
 struct armor_context {

+       /** The last octet we got. */

        unsigned char lastoctet;
        unsigned char lastoctet;

+       /** The current octet we're expecting (0, 1 or 2). */

        int curoctet;
        int curoctet;

+       /** The number of octets we've seen. */

        int count;
        int count;

+       /** A running CRC24 of the data we've seen. */

        long crc24;
        long crc24;

-       int (*putchar_func)(void *ctx, size_t count, unsigned char *c);
+       /** The function to output a character. */
+       int (*putchar_func)(void *ctx, size_t count, void *c);
+       /** Context for putchar_func. */

        void *ctx;
 };
 
        void *ctx;
 };
 


@@ -143,7 +164,6 @@ static int armor_putchar_int(void *ctx, unsigned char c)
        unsigned char t;
        int i;
 
        unsigned char t;
        int i;
 

-       log_assert(ctx != NULL);

        state = (struct armor_context *) ctx;
 
        switch (state->curoctet++) {
        state = (struct armor_context *) ctx;
 
        switch (state->curoctet++) {


@@ -184,31 +204,33 @@ static int armor_putchar_int(void *ctx, unsigned char c)
 }
 
 
 }
 
 

-static int armor_putchar(void *ctx, size_t count, unsigned char *c)
+static int armor_putchar(void *ctx, size_t count, void *c)

 {
        int i;
 
 {
        int i;
 

+

        for (i = 0; i < count; i++) {
        for (i = 0; i < count; i++) {

-               armor_putchar_int(ctx, c[i]);
+               armor_putchar_int(ctx, ((char *) c)[i]);

        }
        
        return 0;
 }
 
 /**
        }
        
        return 0;
 }
 
 /**

- *     @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 {
  */
 struct dearmor_context {

+       /** The last octet we got. */

        unsigned char lastoctet;
        unsigned char lastoctet;

+       /** The current octet we're expecting (0, 1 or 2). */

        int curoctet;
        int curoctet;

+       /** The number of octets we've seen. */

        int count;
        int count;

+       /** A running CRC24 of the data we've seen. */

        long crc24;
        long crc24;

-       int (*getchar_func)(void *ctx, size_t count, unsigned char *c);
+       /** The function to get the next character. */
+       int (*getchar_func)(void *ctx, size_t count, void *c);
+       /** Context for getchar_func. */

        void *ctx;
 };
 
        void *ctx;
 };
 


@@ -244,7 +266,6 @@ static int dearmor_getchar(void *ctx, unsigned char *c)
        unsigned char tmpc;
        int i;
 
        unsigned char tmpc;
        int i;
 

-       log_assert(ctx != NULL);

        state = (struct dearmor_context *) ctx;
        *c = 0;
        
        state = (struct dearmor_context *) ctx;
        *c = 0;
        


@@ -289,28 +310,19 @@ static int dearmor_getchar(void *ctx, unsigned char *c)
        return (tmpc == 64);
 }
 
        return (tmpc == 64);
 }
 

-static int dearmor_getchar_c(void *ctx, size_t count, unsigned char *c)
+static int dearmor_getchar_c(void *ctx, size_t count, void *c)

 {
        int i, rc = 0;
 
        for (i = 0; i < count && rc == 0; i++) {
 {
        int i, rc = 0;
 
        for (i = 0; i < count && rc == 0; i++) {

-               rc = dearmor_getchar(ctx, &c[i]);
+               rc = dearmor_getchar(ctx, &((unsigned char *) c)[i]);

        }
 
        return rc;
 }
 
        }
 
        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,
 int armor_openpgp_stream(int (*putchar_func)(void *ctx, size_t count,

-                                               unsigned char *c),
+                                               void *c),

                                void *ctx,
                                struct openpgp_packet_list *packets)
 {
                                void *ctx,
                                struct openpgp_packet_list *packets)
 {


@@ -321,8 +333,8 @@ int armor_openpgp_stream(int (*putchar_func)(void *ctx, size_t count,
         */
        putchar_func(ctx, sizeof("-----BEGIN PGP PUBLIC KEY BLOCK-----\n") - 1,
                (unsigned char *) "-----BEGIN PGP PUBLIC KEY BLOCK-----\n");
         */
        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 " PACKAGE_VERSION "\n\n") - 1,
-               (unsigned char *) "Version: onak " PACKAGE_VERSION "\n\n");
+       putchar_func(ctx, sizeof("Version: onak " ONAK_VERSION "\n\n") - 1,
+               (unsigned char *) "Version: onak " ONAK_VERSION "\n\n");

        
        armor_init(&armor_ctx);
        armor_ctx.putchar_func = putchar_func;
        
        armor_init(&armor_ctx);
        armor_ctx.putchar_func = putchar_func;


@@ -339,18 +351,8 @@ int armor_openpgp_stream(int (*putchar_func)(void *ctx, size_t count,
        return 0;
 }
 
        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,
 int dearmor_openpgp_stream(int (*getchar_func)(void *ctx, size_t count,

-                                               unsigned char *c),
+                                               void *c),

                                void *ctx,
                                struct openpgp_packet_list **packets)
 {
                                void *ctx,
                                struct openpgp_packet_list **packets)
 {