Parse PGP data packets. More...

#include <stdio.h>

Include dependency graph for pgppacket.h:

This graph shows which files directly or indirectly include this file:

Enumerations
enum	PacketTags { PT_RES0 = 0 , PT_ESK , PT_SIG , PT_CESK , PT_OPS , PT_SECKEY , PT_PUBKEY , PT_SUBSECKEY , PT_COMPRESSED , PT_SKE , PT_MARKER , PT_LITERAL , PT_TRUST , PT_NAME , PT_SUBKEY , PT_RES15 , PT_COMMENT }
	PGP packet types. More...

Functions
unsigned char *	pgp_read_packet (FILE fp, size_t len)
	Read a PGP packet from a file.

void	pgp_release_packet (void)
	Free the cached PGP packet.

Detailed Description

Parse PGP data packets.

Authors

Richard Russon

Copyright: 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, either version 2 of the License, or (at your option) any later version.

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.

You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.

Definition in file pgppacket.h.

Enumeration Type Documentation

◆ PacketTags

enum PacketTags

PGP packet types.

Enumerator
PT_RES0	reserved
PT_ESK	Encrypted Session Key.
PT_SIG	Signature Packet.
PT_CESK	Conventionally Encrypted Session Key Packet.
PT_OPS	One-Pass Signature Packet.
PT_SECKEY	Secret Key Packet.
PT_PUBKEY	Public Key Packet.
PT_SUBSECKEY	Secret Subkey Packet.
PT_COMPRESSED	Compressed Data Packet.
PT_SKE	Symmetrically Encrypted Data Packet.
PT_MARKER	Marker Packet.
PT_LITERAL	Literal Data Packet.
PT_TRUST	Trust Packet.
PT_NAME	Name Packet.
PT_SUBKEY	Subkey Packet.
PT_RES15	Reserved.
PT_COMMENT	Comment Packet.

Definition at line 35 of file pgppacket.h.

{
  PT_RES0 = 0,   
  PT_ESK,        
  PT_SIG,        
  PT_CESK,       
  PT_OPS,        
  PT_SECKEY,     
  PT_PUBKEY,     
  PT_SUBSECKEY,  
  PT_COMPRESSED, 
  PT_SKE,        
  PT_MARKER,     
  PT_LITERAL,    
  PT_TRUST,      
  PT_NAME,       
  PT_SUBKEY,     
  PT_RES15,      
  PT_COMMENT,    
};

Function Documentation

◆ pgp_read_packet()

unsigned char * pgp_read_packet	(	FILE *	fp,
		size_t *	len )

Read a PGP packet from a file.

Parameters

[in]	fp	File to read from
[out]	len	Number of bytes read

Return values

ptr	PGP data packet

This function uses a cache to store the data: NcryptModuleData::packet_buf

Definition at line 78 of file pgppacket.c.

{
  struct NcryptModuleData *mod_data = neomutt_get_module_data(NeoMutt, MODULE_ID_NCRYPT);
  size_t used = 0;
  LOFF_T startpos;
  unsigned char ctb;
  unsigned char b;
  size_t material;
 
  startpos = ftello(fp);
  if (startpos < 0)
    return NULL;
 
  if (mod_data->packet_buf_len == 0)
  {
    mod_data->packet_buf_len = CHUNK_SIZE;
    mod_data->packet_buf = MUTT_MEM_MALLOC(mod_data->packet_buf_len, unsigned char);
  }
 
  if (fread(&ctb, 1, 1, fp) < 1)
  {
    if (!feof(fp))
      mutt_perror("fread");
    goto bail;
  }
 
  if (!(ctb & 0x80))
  {
    goto bail;
  }
 
  if (ctb & 0x40) /* handle PGP 5.0 packets. */
  {
    bool partial = false;
    mod_data->packet_buf[0] = ctb;
    used++;
 
    do
    {
      if (fread(&b, 1, 1, fp) < 1)
      {
        mutt_perror("fread");
        goto bail;
      }
 
      if (b < 192)
      {
        material = b;
        partial = false;
      }
      else if (b <= 223)
      {
        material = (b - 192) * 256;
        if (fread(&b, 1, 1, fp) < 1)
        {
          mutt_perror("fread");
          goto bail;
        }
        material += b + 192;
        partial = false;
      }
      else if (b < 255)
      {
        material = 1 << (b & 0x1f);
        partial = true;
      }
      else /* b == 255 */
      {
        unsigned char buf[4];
        if (fread(buf, 4, 1, fp) < 1)
        {
          mutt_perror("fread");
          goto bail;
        }
        material = (size_t) buf[0] << 24;
        material |= buf[1] << 16;
        material |= buf[2] << 8;
        material |= buf[3];
        partial = false;
      }
 
      if (read_material(material, &used, fp) == -1)
        goto bail;
 
    } while (partial);
  }
  else /* Old-Style PGP */
  {
    int bytes = 0;
    mod_data->packet_buf[0] = 0x80 | ((ctb >> 2) & 0x0f);
    used++;
 
    switch (ctb & 0x03)
    {
      case 0:
      {
        if (fread(&b, 1, 1, fp) < 1)
        {
          mutt_perror("fread");
          goto bail;
        }
 
        material = b;
        break;
      }
 
      case 1:
        bytes = 2;
        FALLTHROUGH;
 
      case 2:
      {
        if (!bytes)
          bytes = 4;
 
        material = 0;
 
        for (int i = 0; i < bytes; i++)
        {
          if (fread(&b, 1, 1, fp) < 1)
          {
            mutt_perror("fread");
            goto bail;
          }
 
          material = (material << 8) + b;
        }
        break;
      }
 
      default:
        goto bail;
    }
 
    if (read_material(material, &used, fp) == -1)
      goto bail;
  }
 
  if (len)
    *len = used;
 
  return mod_data->packet_buf;
 
bail:
 
  (void) mutt_file_seek(fp, startpos, SEEK_SET);
  return NULL;
}

Here is the call graph for this function:

Here is the caller graph for this function:

◆ pgp_release_packet()

void pgp_release_packet ( void )

Free the cached PGP packet.

Free the data stored in NcryptModuleData::packet_buf

Definition at line 232 of file pgppacket.c.

{
  struct NcryptModuleData *mod_data = neomutt_get_module_data(NeoMutt, MODULE_ID_NCRYPT);
  mod_data->packet_buf_len = 0;
  FREE(&mod_data->packet_buf);
}