crypto/external/bsd/netpgp/dist/src/lib/writer.h

   1 /*-
   2  * Copyright (c) 2009 The NetBSD Foundation, Inc.
   3  * All rights reserved.
   4  *
   5  * This code is derived from software contributed to The NetBSD Foundation
   6  * by Alistair Crooks (agc@NetBSD.org)
   7  *
   8  * Redistribution and use in source and binary forms, with or without
   9  * modification, are permitted provided that the following conditions
  10  * are met:
  11  * 1. Redistributions of source code must retain the above copyright
  12  *    notice, this list of conditions and the following disclaimer.
  13  * 2. Redistributions in binary form must reproduce the above copyright
  14  *    notice, this list of conditions and the following disclaimer in the
  15  *    documentation and/or other materials provided with the distribution.
  16  *
  17  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
  18  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
  19  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  20  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
  21  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  22  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  23  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  24  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  25  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  26  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  27  * POSSIBILITY OF SUCH DAMAGE.
  28  */
  29 /*
  30  * Copyright (c) 2005-2008 Nominet UK (www.nic.uk)
  31  * All rights reserved.
  32  * Contributors: Ben Laurie, Rachel Willmer. The Contributors have asserted
  33  * their moral rights under the UK Copyright Design and Patents Act 1988 to
  34  * be recorded as the authors of this copyright work.
  35  *
  36  * Licensed under the Apache License, Version 2.0 (the "License"); you may not
  37  * use this file except in compliance with the License.
  38  *
  39  * You may obtain a copy of the License at
  40  *     http://www.apache.org/licenses/LICENSE-2.0
  41  *
  42  * Unless required by applicable law or agreed to in writing, software
  43  * distributed under the License is distributed on an "AS IS" BASIS,
  44  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  45  *
  46  * See the License for the specific language governing permissions and
  47  * limitations under the License.
  48  */
  49
  50 /** \file
  51  */
  52
  53 #ifndef WRITER_H_
  54 #define WRITER_H_
  55
  56 #include "types.h"
  57 #include "packet.h"
  58 #include "crypto.h"
  59 #include "errors.h"
  60 #include "keyring.h"
  61
  62 /**
  63  * \ingroup Create
  64  * This struct contains the required information about one writer
  65  */
  66 /**
  67  * \ingroup Writer
  68  * the writer function prototype
  69  */
  70
  71 typedef struct __ops_writer_t   __ops_writer_t;
  72 typedef unsigned __ops_writer_func_t(const unsigned char *,
  73              unsigned,
  74              __ops_error_t **,
  75              __ops_writer_t *);
  76 typedef unsigned
  77 __ops_writer_finaliser_t(__ops_error_t **, __ops_writer_t *);
  78 typedef void    __ops_writer_destroyer_t(__ops_writer_t *);
  79
  80 /** Writer settings */
  81 struct __ops_writer_t {
  82         __ops_writer_func_t      *writer;       /* the writer itself */
  83         __ops_writer_finaliser_t *finaliser;    /* the writer's finaliser */
  84         __ops_writer_destroyer_t *destroyer;    /* the writer's destroyer */
  85         void                     *arg;  /* writer-specific argument */
  86         __ops_writer_t           *next; /* next writer in the stack */
  87         __ops_io_t               *io;   /* IO for errors and output */
  88 };
  89
  90
  91 void *__ops_writer_get_arg(__ops_writer_t *);
  92 unsigned __ops_stacked_write(const void *, unsigned,
  93                   __ops_error_t **,
  94                   __ops_writer_t *);
  95
  96 void __ops_writer_set(__ops_output_t *,
  97                __ops_writer_func_t *,
  98                __ops_writer_finaliser_t *,
  99                __ops_writer_destroyer_t *,
 100                void *);
 101 void __ops_writer_push(__ops_output_t *,
 102                 __ops_writer_func_t *,
 103                 __ops_writer_finaliser_t *,
 104                 __ops_writer_destroyer_t *,
 105                 void *);
 106 void __ops_writer_pop(__ops_output_t *);
 107 unsigned __ops_writer_passthrough(const unsigned char *,
 108                        unsigned,
 109                        __ops_error_t **,
 110                        __ops_writer_t *);
 111
 112 void __ops_writer_set_fd(__ops_output_t *, int);
 113 unsigned __ops_writer_close(__ops_output_t *);
 114
 115 unsigned __ops_write(__ops_output_t *, const void *, unsigned);
 116 unsigned __ops_write_length(__ops_output_t *, unsigned);
 117 unsigned __ops_write_ptag(__ops_output_t *, __ops_content_tag_t);
 118 unsigned __ops_write_scalar(__ops_output_t *, unsigned, unsigned);
 119 unsigned __ops_write_mpi(__ops_output_t *, const BIGNUM *);
 120
 121 void writer_info_delete(__ops_writer_t *);
 122 unsigned writer_info_finalise(__ops_error_t **, __ops_writer_t *);
 123
 124 void __ops_push_stream_enc_se_ip(__ops_output_t *, const __ops_key_t *);
 125
 126 #endif /* WRITER_H_ */