* (c) 2004 Straylight/Edgeware
*/
-/*----- Licensing notice --------------------------------------------------*
+/*----- Licensing notice --------------------------------------------------*
*
* This file is part of Catacomb.
*
* it under the terms of the GNU Library General Public License as
* published by the Free Software Foundation; either version 2 of the
* License, or (at your option) any later version.
- *
+ *
* Catacomb 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 Library General Public License for more details.
- *
+ *
* You should have received a copy of the GNU Library General Public
* License along with Catacomb; if not, write to the Free
* Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
/*----- Header files ------------------------------------------------------*/
+#if _FILE_OFFSET_BITS != 64
+# error "Must set _FILE_OFFSET_BITS to 64."
+#endif
+
#include <stdio.h>
#include <string.h>
+#include <time.h>
#include <mLib/dstr.h>
#include "ghash.h"
#include "gmac.h"
-/*----- Data structures ---------------------------------------------------*/
+/*----- Cryptographic object tables ---------------------------------------*/
/* --- Key encapsulation --- */
extern const struct kemtab kemtab[];
-/* --- Signing --- */
-
-typedef struct sig {
- const struct sigops *ops;
- key_packdef *kp;
- void *kd;
- ghash *h;
-} sig;
-
-typedef struct sigops {
- const key_fetchdef *kf; /* Key fetching structure */
- size_t kdsz; /* Size of the key-data structure */
- sig *(*init)(key */*k*/, void */*kd*/, const gchash */*hc*/);
- int (*doit)(sig */*s*/, dstr */*d*/);
- const char *(*check)(sig */*s*/);
- void (*destroy)(sig */*s*/);
-} sigops;
-
-struct sigtab {
- const char *name;
- const sigops *signops;
- const sigops *verifyops;
- const gchash *ch;
-};
-
-extern const struct sigtab sigtab[];
-
-/* --- Data encoding --- */
-
-typedef struct enc {
- const struct encops *ops;
- FILE *fp;
-} enc;
-
-typedef struct encops {
- const char *name;
- const char *rmode, *wmode;
- enc *(*initenc)(FILE */*fp*/, const char */*msg*/);
- enc *(*initdec)(FILE */*fp*/, const char */*msg*/);
- int (*read)(enc */*e*/, void */*p*/, size_t /*sz*/);
- int (*write)(enc */*e*/, const void */*p*/, size_t /*sz*/);
- int (*encdone)(enc */*e*/);
- int (*decdone)(enc */*e*/);
- void (*destroy)(enc */*e*/);
-} encops;
-
-extern const encops enctab[];
-
-/*----- Functions provided ------------------------------------------------*/
-
/* --- @getkem@ --- *
*
* Arguments: @key *k@ = the key to load
extern void freekem(kem */*k*/);
+/* --- Signing --- */
+
+typedef struct sig {
+ const struct sigops *ops;
+ key_packdef *kp;
+ void *kd;
+ const gchash *ch;
+ ghash *h;
+} sig;
+
+typedef struct sigops {
+ const key_fetchdef *kf; /* Key fetching structure */
+ size_t kdsz; /* Size of the key-data structure */
+ sig *(*init)(key */*k*/, void */*kd*/, const gchash */*hc*/);
+ int (*doit)(sig */*s*/, dstr */*d*/);
+ const char *(*check)(sig */*s*/);
+ void (*destroy)(sig */*s*/);
+} sigops;
+
+struct sigtab {
+ const char *name;
+ const sigops *signops;
+ const sigops *verifyops;
+ const gchash *ch;
+};
+
+extern const struct sigtab sigtab[];
+
/* --- @getsig@ --- *
*
* Arguments: @key *k@ = the key to load
extern void freesig(sig */*s*/);
+/*----- File encodings ----------------------------------------------------*/
+
+/* --- Data encoding --- */
+
+typedef struct enc {
+ const struct encops *ops;
+ FILE *fp;
+} enc;
+
+typedef struct encops {
+ const char *name;
+ const char *rmode, *wmode;
+ int nraw, ncook;
+ enc *(*initenc)(FILE */*fp*/, const char */*msg*/);
+ enc *(*initdec)(FILE */*fp*/,
+ int (*/*func*/)(const char *, void *), void */*p*/);
+ int (*read)(enc */*e*/, void */*p*/, size_t /*sz*/);
+ int (*write)(enc */*e*/, const void */*p*/, size_t /*sz*/);
+ int (*encdone)(enc */*e*/);
+ int (*decdone)(enc */*e*/);
+ void (*destroy)(enc */*e*/);
+} encops;
+
+extern const encops enctab[];
+
/* --- @getenc@ --- *
*
* Arguments: @const char *enc@ = name of wanted encoding
extern const encops *getenc(const char */*enc*/);
+/* --- @checkbdry@ --- *
+ *
+ * Arguments: @const char *b@ = boundary string found
+ * @void *p@ = boundary string wanted
+ *
+ * Returns: Nonzero if the boundary string is the one we wanted.
+ *
+ * Use: Pass as @func@ to @initdec@ if you just want a simple life.
+ */
+
+extern int checkbdry(const char */*b*/, void */*p*/);
+
/* --- @initenc@ --- *
*
* Arguments: @const encops *eo@ = operations (from @getenc@)
* @FILE *fp@ = file handle to attach
* @const char *msg@ = banner message
- * @int wantenc@ = nonzero if we want to encode
*
* Returns: The encoder object.
*
* Use: Initializes an encoder.
*/
-extern enc *initenc(const encops */*eo*/, FILE */*fp*/,
- const char */*msg*/, int /*wantenc*/);
+extern enc *initenc(const encops */*eo*/, FILE */*fp*/, const char */*msg*/);
+
+/* --- @initdec@ --- *
+ *
+ * Arguments: @const encops *eo@ = operations (from @getenc@)
+ * @FILE *fp@ = file handle to attach
+ * @int (*func)(const char *, void *)@ = banner check function
+ * @void *p@ = argument for @func@
+ *
+ * Returns: The encoder object.
+ *
+ * Use: Initializes an encoder.
+ */
+
+extern enc *initdec(const encops */*eo*/, FILE */*fp*/,
+ int (*/*func*/)(const char *, void *), void */*p*/);
/* --- @freeenc@ --- *
*
extern void freeenc(enc */*e*/);
+/* --- @cmd_encode@, @cmd_decode@ --- */
+
+#define CMD_ENCODE { \
+ "encode", cmd_encode, \
+ "encode [-p] [-f FORMAT] [-b LABEL] [-o OUTPUT] [FILE]", \
+ "\
+Options:\n\
+\n\
+-f, --format=FORMAT Encode to FORMAT.\n\
+-b, --boundary=LABEL PEM boundary is LABEL.\n\
+-o, --output=FILE Write output to FILE.\n\
+-p, --progress Show progress on large files.\n\
+" }
+
+#define CMD_DECODE { \
+ "decode", cmd_decode, \
+ "decode [-p] [-f FORMAT] [-b LABEL] [-o OUTPUT] [FILE]", \
+ "\
+Options:\n\
+\n\
+-f, --format=FORMAT Decode from FORMAT.\n\
+-b, --boundary=LABEL PEM boundary is LABEL.\n\
+-o, --output=FILE Write output to FILE.\n\
+-p, --progress Show progress on large files.\n\
+" }
+
+extern int cmd_encode(int /*argc*/, char */*argv*/[]);
+extern int cmd_decode(int /*argc*/, char */*argv*/[]);
+
+/*----- Lists of things ---------------------------------------------------*/
+
/* --- @LIST(STRING, FP, END-TEST, NAME-EXPR)@ --- *
*
* Produce list of things. Requires @i@ and @w@ variables in scope.
extern int displaylists(const struct listent */*listtab*/,
char *const /*argv*/[]);
+/*----- Progress indicators -----------------------------------------------*/
+
+typedef struct fprogress {
+ const char *bp;
+ off_t o, sz, olast;
+ time_t start, last;
+ char name[24];
+} fprogress;
+
+/* --- @fprogress_init@ --- *
+ *
+ * Arguments: @fprogress *f@ = progress context to be initialized
+ * @const char *name@ = file name string to show
+ * @FILE *fp@ = file we're reading from
+ *
+ * Returns: Zero on success, nonzero if the file's state is now broken.
+ *
+ * Use: Initializes a progress context. Nothing is actually
+ * displayed yet.
+ */
+
+extern int fprogress_init(fprogress */*f*/,
+ const char */*name*/, FILE */*fp*/);
+
+/* --- @fprogress_update@ --- *
+ *
+ * Arguments: @fprogress *f@ = progress context
+ * @size_t n@ = how much progress has been made
+ *
+ * Returns: ---
+ *
+ * Use: Maybe updates the display to show that some progress has been
+ * made.
+ */
+
+extern void fprogress_update(fprogress */*f*/, size_t /*n*/);
+
+/* --- @fprogress_clear@ --- *
+ *
+ * Arguments: @fprogress *f@ = progress context
+ *
+ * Returns: ---
+ *
+ * Use: Clears the progress display from the screen.
+ */
+
+extern void fprogress_clear(fprogress */*f*/);
+
+/* --- @fprogress_done@ --- *
+ *
+ * Arguments: @fprogress *f@ = progress context
+ *
+ * Returns: ---
+ *
+ * Use: Clear up the progress context and removes any display.
+ */
+
+extern void fprogress_done(fprogress */*f*/);
+
/*----- Subcommand dispatch -----------------------------------------------*/
typedef struct cmd {
projects / u / mdw / catacomb / blobdiff