mirror of
git://git.gnupg.org/gnupg.git
synced 2024-12-24 10:39:57 +01:00
b008274afd
We better do this once and for all instead of cluttering all future commits with diffs of trailing white spaces. In the majority of cases blank or single lines are affected and thus this change won't disturb a git blame too much. For future commits the pre-commit scripts checks that this won't happen again.
128 lines
4.9 KiB
C
128 lines
4.9 KiB
C
/* keyblob.h - Defs to describe a keyblob
|
||
* Copyright (C) 2009 Free Software Foundation, Inc.
|
||
*
|
||
* This file is part of GnuPG.
|
||
*
|
||
* GnuPG 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; either version 3 of the License, or
|
||
* (at your option) any later version.
|
||
*
|
||
* GnuPG 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, see <http://www.gnu.org/licenses/>.
|
||
*/
|
||
|
||
#ifndef G13_KEYBLOB_H
|
||
#define G13_KEYBLOB_H
|
||
|
||
/* The header block is the actual core of G13. Here is the format:
|
||
|
||
u8 Packet type. Value is 61 (0x3d).
|
||
u8 Constant value 255 (0xff).
|
||
u32 Length of the following structure
|
||
b10 Value: "GnuPG/G13\x00".
|
||
u8 Version. Value is 1.
|
||
u8 reserved
|
||
u8 reserved
|
||
u8 OS Flag: reserved, should be 0.
|
||
u32 Length of the entire header. This includes all bytes
|
||
starting at the packet type and ending with the last
|
||
padding byte of the header.
|
||
u8 Number of copies of this header (1..255).
|
||
u8 Number of copies of this header at the end of the
|
||
container (usually 0).
|
||
b6 reserved
|
||
n bytes: OpenPGP encrypted and optionally signed message.
|
||
n bytes: CMS encrypted and optionally signed packet. Such a CMS
|
||
packet will be enclosed in a a private flagged OpenPGP
|
||
packet. Either the OpenPGP encrypted packet as described
|
||
above, the CMS encrypted or both packets must exist. The
|
||
encapsulation packet has this structure:
|
||
u8 Packet type. Value is 61 (0x3d).
|
||
u8 Constant value 255 (0xff).
|
||
u32 Length of the following structure
|
||
b10 Value: "GnuPG/CMS\x00".
|
||
b(n) Regular CMS structure.
|
||
n bytes: Padding. The structure resembles an OpenPGP packet.
|
||
u8 Packet type. Value is 61 (0x3d).
|
||
u8 Constant value 255 (0xff).
|
||
u32 Length of the following structure
|
||
b10 Value: "GnuPG/PAD\x00".
|
||
b(n) Padding stuff.
|
||
Given this structure the minimum padding is 16 bytes.
|
||
|
||
n bytes: File system container.
|
||
(optionally followed by copies on the header).
|
||
*/
|
||
|
||
|
||
#define KEYBLOB_TAG_BLOBVERSION 0
|
||
/* This tag is used to describe the version of the keyblob. It must
|
||
be the first tag in a keyblob and may only occur once. Its value
|
||
is a single byte giving the blob version. The only defined version
|
||
is 1. */
|
||
|
||
#define KEYBLOB_TAG_CONTTYPE 1
|
||
/* This tag gives the type of the container. The value is a two byte
|
||
big endian integer giving the type of the container as described by
|
||
the CONTTYPE_ constants. */
|
||
|
||
#define KEYBLOB_TAG_DETACHED 2
|
||
/* Indicates that the actual storage is not in the same file as the
|
||
keyblob. If a value is given it is expected to be the GUID of the
|
||
partition. */
|
||
|
||
#define KEYBLOB_TAG_KEYNO 16
|
||
/* This tag indicates a new key. The value is a 4 byte big endian
|
||
integer giving the key number. If the container type does only
|
||
need one key this key number should be 0. */
|
||
|
||
#define KEYBLOB_TAG_ENCALGO 17
|
||
/* Describes the algorithm of the key. It must follow a KEYNO tag.
|
||
The value is a 2 byte big endian algorithm number. The algorithm
|
||
numbers used are those from Libgcrypt (e.g. AES 128 is described by
|
||
the value 7). This tag is optional. */
|
||
|
||
#define KEYBLOB_TAG_ENCKEY 18
|
||
/* This tag gives the actual encryption key. It must follow a KEYNO
|
||
tag. The value is the plain key. */
|
||
|
||
#define KEYBLOB_TAG_MACALGO 19
|
||
/* Describes the MAC algorithm. It must follow a KEYNO tag. The
|
||
value is a 2 byte big endian algorithm number describing the MAC
|
||
algorithm with a value of 1 indicating HMAC. It is followed by
|
||
data specific to the MAC algorithm. In case of HMAC this data is a
|
||
2 byte big endian integer with the Libgcrypt algorithm id of the
|
||
hash algorithm. */
|
||
|
||
#define KEYBLOB_TAG_MACKEY 20
|
||
/* This tag gives the actual MACing key. It must follow a KEYNO tag.
|
||
The value is the key used for MACing. */
|
||
|
||
|
||
#define KEYBLOB_TAG_FILLER 0xffff
|
||
/* This tag may be used for alignment and padding porposes. The value
|
||
has no meaning. */
|
||
|
||
|
||
|
||
#define CONTTYPE_ENCFS 1
|
||
/* A EncFS based backend. This requires a whole directory which
|
||
includes the encrypted files. Metadata is not encrypted. */
|
||
|
||
|
||
#define CONTTYPE_TRUECRYPT 21571
|
||
/* A Truecrypt (www.truecrypt.org) based container. Due to the design
|
||
of truecrypt this requires a second datafile because it is not
|
||
possible to to prepend a truecrypt container with our keyblob. */
|
||
|
||
|
||
|
||
|
||
#endif /*G13_KEYBLOB_H*/
|