photoid.h

   1 /*
   2  * photoid.h - Routines for OpenPGP id photos.
   3  *
   4  * Copyright 2004 Jonathan McDowell <noodles@earth.li>
   5  *
   6  * This program is free software: you can redistribute it and/or modify it
   7  * under the terms of the GNU General Public License as published by the Free
   8  * Software Foundation; version 2 of the License.
   9  *
  10  * This program is distributed in the hope that it will be useful, but WITHOUT
  11  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  12  * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
  13  * more details.
  14  *
  15  * You should have received a copy of the GNU General Public License along with
  16  * this program; if not, write to the Free Software Foundation, Inc., 51
  17  * Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  18  */
  19
  20 #ifndef __PHOTOID_H__
  21 #define __PHOTOID_H__
  22
  23 #include "keystructs.h"
  24
  25 /**
  26  *      getphoto - returns an OpenPGP packet containing a photo id.
  27  *      @key: The key to return the photo id from.
  28  *      @index: The index of the photo to return.
  29  *      @photo: The photo data.
  30  *      @length: The length of the photo data.
  31  *
  32  *      This function returns the photo data contained in a supplied key.
  33  *      index specifies which photo id should be returned. If there's no such
  34  *      photo id NULL is returned. The returned data pointer refers to the key
  35  *      data supplied rather than a copy of it.
  36  */
  37 onak_status_t getphoto(struct openpgp_publickey *key, int index,
  38                 unsigned char **photo, size_t *length);
  39
  40 #endif /* __PHOTOID_H__ */