pgplib.h File Reference

Misc PGP helper routines. More...

#include <stdbool.h>
#include <time.h>
#include "mutt/lib.h"
#include "lib.h"

Include dependency graph for pgplib.h:

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

Go to the source code of this file.

Data Structures
struct	PgpUid
	PGP User ID. More...
struct	PgpKeyInfo
	Information about a PGP key. More...

Enumerations
enum	ExpandoDataPgpKey {   ED_PGK_DATE = 1 , ED_PGK_KEY_ALGORITHM , ED_PGK_KEY_CAPABILITIES , ED_PGK_KEY_FINGERPRINT ,   ED_PGK_KEY_FLAGS , ED_PGK_KEY_ID , ED_PGK_KEY_LENGTH , ED_PGK_PKEY_ALGORITHM ,   ED_PGK_PKEY_CAPABILITIES , ED_PGK_PKEY_FINGERPRINT , ED_PGK_PKEY_FLAGS , ED_PGK_PKEY_ID ,   ED_PGK_PKEY_LENGTH , ED_PGK_PROTOCOL }
	Expando UIDs for PGP Keys. More...

Functions
	ARRAY_HEAD (PgpUidArray, struct PgpUid *)
const char *	pgp_pkalgbytype (unsigned char type)
	Get the name of the algorithm from its ID.
struct PgpUid *	pgp_copy_uids (struct PgpUid *up, struct PgpKeyInfo *parent)
	Copy a list of PGP UIDs.
bool	pgp_canencrypt (unsigned char type)
	Does this algorithm ID support encryption?
bool	pgp_cansign (unsigned char type)
	Does this algorithm ID support signing?
void	pgp_key_free (struct PgpKeyInfo **kpp)
	Free a PGP key info.
struct PgpKeyInfo *	pgp_remove_key (struct PgpKeyInfo **klist, struct PgpKeyInfo *key)
	Remove a PGP key from a list.
struct PgpKeyInfo *	pgp_keyinfo_new (void)

Detailed Description

Misc PGP helper routines.

Authors

• Pietro Cerutti
• 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 pgplib.h.

Enumeration Type Documentation

ExpandoDataPgpKey

enum ExpandoDataPgpKey

Expando UIDs for PGP Keys.

See also

ED_PGP_KEY, ExpandoDomain

Enumerator
ED_PGK_DATE	PgpKeyInfo.gen_time.
ED_PGK_KEY_ALGORITHM	PgpKeyInfo.algorithm.
ED_PGK_KEY_CAPABILITIES	PgpKeyInfo.flags, pgp_key_abilities()
ED_PGK_KEY_FINGERPRINT	PgpKeyInfo.fingerprint.
ED_PGK_KEY_FLAGS	PgpKeyInfo.kflags, pgp_flags()
ED_PGK_KEY_ID	PgpKeyInfo, pgp_this_keyid()
ED_PGK_KEY_LENGTH	PgpKeyInfo.keylen.
ED_PGK_PKEY_ALGORITHM	pgp_principal_key(), PgpKeyInfo.algorithm
ED_PGK_PKEY_CAPABILITIES	pgp_principal_key(), PgpKeyInfo.flags, pgp_key_abilities()
ED_PGK_PKEY_FINGERPRINT	pgp_principal_key(), PgpKeyInfo.fingerprint
ED_PGK_PKEY_FLAGS	pgp_principal_key(), PgpKeyInfo.kflags, pgp_flags()
ED_PGK_PKEY_ID	pgp_principal_key(), PgpKeyInfo, pgp_this_keyid()
ED_PGK_PKEY_LENGTH	pgp_principal_key(), PgpKeyInfo.keylen
ED_PGK_PROTOCOL	PgpKeyInfo.

Definition at line 67 of file pgplib.h.

{
  ED_PGK_DATE = 1,             
  ED_PGK_KEY_ALGORITHM,        
  ED_PGK_KEY_CAPABILITIES,     
  ED_PGK_KEY_FINGERPRINT,      
  ED_PGK_KEY_FLAGS,            
  ED_PGK_KEY_ID,               
  ED_PGK_KEY_LENGTH,           
  ED_PGK_PKEY_ALGORITHM,       
  ED_PGK_PKEY_CAPABILITIES,    
  ED_PGK_PKEY_FINGERPRINT,     
  ED_PGK_PKEY_FLAGS,           
  ED_PGK_PKEY_ID,              
  ED_PGK_PKEY_LENGTH,          
  ED_PGK_PROTOCOL,             
};

Function Documentation

ARRAY_HEAD()

ARRAY_HEAD	(	PgpUidArray	,
		struct PgpUid *
	)

pgp_pkalgbytype()

const char * pgp_pkalgbytype

(

unsigned char

type

)

Get the name of the algorithm from its ID.

Parameters

type	Algorithm ID

Return values

ptr	Algorithm name

Definition at line 42 of file pgplib.c.

{
  switch (type)
  {
    case 1:
      return "RSA";
    case 2:
      return "RSA";
    case 3:
      return "RSA";
    case 16:
      return "ElG";
    case 17:
      return "DSA";
    case 20:
      return "ElG";
    default:
      return "unk";
  }
}

Here is the caller graph for this function:

pgp_copy_uids()

struct PgpUid * pgp_copy_uids	(	struct PgpUid *	up,
		struct PgpKeyInfo *	parent
	)

Copy a list of PGP UIDs.

Parameters

up	List of PGP UIDs
parent	Parent PGP key

Return values

ptr	New list of PGP UIDs

Definition at line 127 of file pgplib.c.

{
  struct PgpUid *l = NULL;
  struct PgpUid **lp = &l;
 
  for (; up; up = up->next)
  {
    *lp = MUTT_MEM_CALLOC(1, struct PgpUid);
    (*lp)->trust = up->trust;
    (*lp)->flags = up->flags;
    (*lp)->addr = mutt_str_dup(up->addr);
    (*lp)->parent = parent;
    lp = &(*lp)->next;
  }
 
  return l;
}

Here is the call graph for this function:

Here is the caller graph for this function:

pgp_canencrypt()

bool pgp_canencrypt

(

unsigned char

type

)

Does this algorithm ID support encryption?

Parameters

type	Algorithm ID

Return values

true	Algorithm does support encryption

Definition at line 68 of file pgplib.c.

{
  switch (type)
  {
    case 1:
    case 2:
    case 16:
    case 20:
      return true;
    default:
      return false;
  }
}

pgp_cansign()

bool pgp_cansign

(

unsigned char

type

)

Does this algorithm ID support signing?

Parameters

type	Algorithm ID

Return values

true	Algorithm does support signing

Definition at line 87 of file pgplib.c.

{
  switch (type)
  {
    case 1:
    case 3:
    case 17:
    case 20:
      return true;
    default:
      return false;
  }
}

pgp_key_free()

void pgp_key_free

(

struct PgpKeyInfo **

kpp

)

Free a PGP key info.

Parameters

[out]

kpp

PGP key info to free

Definition at line 201 of file pgplib.c.

{
  if (!kpp || !*kpp)
    return;
 
  struct PgpKeyInfo *p = NULL, *q = NULL, *r = NULL;
 
  if ((*kpp)->parent && ((*kpp)->parent != *kpp))
    *kpp = (*kpp)->parent;
 
  /* Order is important here:
   *
   * - First free all children.
   * - If we are an orphan (i.e., our parent was not in the key list),
   *   free our parent.
   * - free ourselves.  */
 
  for (p = *kpp; p; p = q)
  {
    for (q = p->next; q && q->parent == p; q = r)
    {
      r = q->next;
      key_free(&q);
    }
 
    key_free(&p->parent);
    key_free(&p);
  }
 
  *kpp = NULL;
}

Here is the call graph for this function:

Here is the caller graph for this function:

pgp_remove_key()

struct PgpKeyInfo * pgp_remove_key	(	struct PgpKeyInfo **	klist,
		struct PgpKeyInfo *	key
	)

Remove a PGP key from a list.

Parameters

[out]	klist	List of PGP Keys
[in]	key	Key to remove

Return values

ptr	Updated list of PGP Keys

Definition at line 169 of file pgplib.c.

{
  if (!klist || !*klist || !key)
    return NULL;
 
  struct PgpKeyInfo **last = NULL;
  struct PgpKeyInfo *p = NULL, *q = NULL, *r = NULL;
 
  if (key->parent && (key->parent != key))
    key = key->parent;
 
  last = klist;
  for (p = *klist; p && p != key; p = p->next)
    last = &p->next;
 
  if (!p)
    return NULL;
 
  for (q = p->next, r = p; q && q->parent == p; q = q->next)
    r = q;
 
  if (r)
    r->next = NULL;
 
  *last = q;
  return q;
}

Here is the caller graph for this function:

pgp_keyinfo_new()

struct PgpKeyInfo * pgp_keyinfo_new

(

void

)