Add ability to drop overly large packets

[onak.git] / armor.h

diff --git a/armor.h b/armor.h
index 63f919859222c9b9f0bbf5b5849b7553d982bcf9..bb660a17ed1453d7c1cfe86d106926d3eca9574d 100644 (file)
--- a/armor.h
+++ b/armor.h
@@ -1,9 +1,20 @@
-/*
- * armor.h - Routines to (de)armor OpenPGP packet streams.
+/**
+ * @file armor.h
+ * @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/>.
  */
 
 #ifndef __ARMOR_H__
@@ -12,29 +23,31 @@
 #include "keystructs.h"
 
 /**
- *     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.
+ * @brief Takes a list of OpenPGP packets and armors it.
+ * @param putchar_func The function to output the next armor character.
+ * @param ctx The context pointer for putchar_func.
+ * @param packets The list of packets to output.
  *
- *     This function ASCII armors a list of OpenPGP packets and outputs it
- *     using putchar_func.
+ * This function ASCII armors a list of OpenPGP packets and outputs it
+ * using putchar_func.
  */
-int armor_openpgp_stream(int (*putchar_func)(void *ctx, unsigned char c),
+int armor_openpgp_stream(int (*putchar_func)(void *ctx, size_t count,
+                                               void *c),
                                void *ctx,
                                struct openpgp_packet_list *packets);
 
 /**
- *     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.
+ * @brief Reads & decodes an ACSII armored OpenPGP msg.
+ * @param getchar_func The function to get the next character from the stream.
+ * @param ctx The context pointer for getchar_func.
+ * @param 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.
+ * 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, unsigned char *c),
+int dearmor_openpgp_stream(int (*getchar_func)(void *ctx, size_t count,
+                                       void *c),
                                void *ctx,
                                struct openpgp_packet_list **packets);