NeoMutt  2024-04-25-97-g7d2481
Teaching an old dog new tricks
DOXYGEN
Loading...
Searching...
No Matches
pgplib.h File Reference

Misc PGP helper routines. More...

#include <stdbool.h>
#include <time.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

const char * pgp_pkalgbytype (unsigned char type)
 Get the name of the algorithm from its ID.
 
struct PgpUidpgp_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 PgpKeyInfopgp_remove_key (struct PgpKeyInfo **klist, struct PgpKeyInfo *key)
 Remove a PGP key from a list.
 
struct PgpKeyInfopgp_keyinfo_new (void)
 

Detailed Description

Misc PGP helper routines.

Authors
  • Pietro Cerutti
  • Richard Russon

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

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 65 of file pgplib.h.

66{
67 ED_PGK_DATE = 1,
81};
@ ED_PGK_KEY_CAPABILITIES
PgpKeyInfo.flags, pgp_key_abilities()
Definition: pgplib.h:69
@ ED_PGK_KEY_FINGERPRINT
PgpKeyInfo.fingerprint.
Definition: pgplib.h:70
@ ED_PGK_PKEY_LENGTH
pgp_principal_key(), PgpKeyInfo.keylen
Definition: pgplib.h:79
@ ED_PGK_PKEY_ALGORITHM
pgp_principal_key(), PgpKeyInfo.algorithm
Definition: pgplib.h:74
@ ED_PGK_DATE
PgpKeyInfo.gen_time.
Definition: pgplib.h:67
@ ED_PGK_PKEY_FINGERPRINT
pgp_principal_key(), PgpKeyInfo.fingerprint
Definition: pgplib.h:76
@ ED_PGK_KEY_ID
PgpKeyInfo, pgp_this_keyid()
Definition: pgplib.h:72
@ ED_PGK_PROTOCOL
PgpKeyInfo.
Definition: pgplib.h:80
@ ED_PGK_PKEY_CAPABILITIES
pgp_principal_key(), PgpKeyInfo.flags, pgp_key_abilities()
Definition: pgplib.h:75
@ ED_PGK_KEY_FLAGS
PgpKeyInfo.kflags, pgp_flags()
Definition: pgplib.h:71
@ ED_PGK_PKEY_ID
pgp_principal_key(), PgpKeyInfo, pgp_this_keyid()
Definition: pgplib.h:78
@ ED_PGK_KEY_ALGORITHM
PgpKeyInfo.algorithm.
Definition: pgplib.h:68
@ ED_PGK_KEY_LENGTH
PgpKeyInfo.keylen.
Definition: pgplib.h:73
@ ED_PGK_PKEY_FLAGS
pgp_principal_key(), PgpKeyInfo.kflags, pgp_flags()
Definition: pgplib.h:77

Function Documentation

◆ pgp_pkalgbytype()

const char * pgp_pkalgbytype ( unsigned char  type)

Get the name of the algorithm from its ID.

Parameters
typeAlgorithm ID
Return values
ptrAlgorithm name

Definition at line 42 of file pgplib.c.

43{
44 switch (type)
45 {
46 case 1:
47 return "RSA";
48 case 2:
49 return "RSA";
50 case 3:
51 return "RSA";
52 case 16:
53 return "ElG";
54 case 17:
55 return "DSA";
56 case 20:
57 return "ElG";
58 default:
59 return "unk";
60 }
61}
+ 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
upList of PGP UIDs
parentParent PGP key
Return values
ptrNew list of PGP UIDs

Definition at line 127 of file pgplib.c.

128{
129 struct PgpUid *l = NULL;
130 struct PgpUid **lp = &l;
131
132 for (; up; up = up->next)
133 {
134 *lp = mutt_mem_calloc(1, sizeof(struct PgpUid));
135 (*lp)->trust = up->trust;
136 (*lp)->flags = up->flags;
137 (*lp)->addr = mutt_str_dup(up->addr);
138 (*lp)->parent = parent;
139 lp = &(*lp)->next;
140 }
141
142 return l;
143}
void * mutt_mem_calloc(size_t nmemb, size_t size)
Allocate zeroed memory on the heap.
Definition: memory.c:51
char * mutt_str_dup(const char *str)
Copy a string, safely.
Definition: string.c:253
PGP User ID.
Definition: pgplib.h:35
short trust
Definition: pgplib.h:37
struct PgpKeyInfo * parent
Parent key.
Definition: pgplib.h:39
int flags
Definition: pgplib.h:38
char * addr
Definition: pgplib.h:36
struct PgpUid * next
Linked list.
Definition: pgplib.h:40
+ 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
typeAlgorithm ID
Return values
trueAlgorithm does support encryption

Definition at line 68 of file pgplib.c.

69{
70 switch (type)
71 {
72 case 1:
73 case 2:
74 case 16:
75 case 20:
76 return true;
77 default:
78 return false;
79 }
80}

◆ pgp_cansign()

bool pgp_cansign ( unsigned char  type)

Does this algorithm ID support signing?

Parameters
typeAlgorithm ID
Return values
trueAlgorithm does support signing

Definition at line 87 of file pgplib.c.

88{
89 switch (type)
90 {
91 case 1:
92 case 3:
93 case 17:
94 case 20:
95 return true;
96 default:
97 return false;
98 }
99}

◆ pgp_key_free()

void pgp_key_free ( struct PgpKeyInfo **  kpp)

Free a PGP key info.

Parameters
[out]kppPGP key info to free

Definition at line 201 of file pgplib.c.

202{
203 if (!kpp || !*kpp)
204 return;
205
206 struct PgpKeyInfo *p = NULL, *q = NULL, *r = NULL;
207
208 if ((*kpp)->parent && ((*kpp)->parent != *kpp))
209 *kpp = (*kpp)->parent;
210
211 /* Order is important here:
212 *
213 * - First free all children.
214 * - If we are an orphan (i.e., our parent was not in the key list),
215 * free our parent.
216 * - free ourselves. */
217
218 for (p = *kpp; p; p = q)
219 {
220 for (q = p->next; q && q->parent == p; q = r)
221 {
222 r = q->next;
223 key_free(&q);
224 }
225
226 key_free(&p->parent);
227 key_free(&p);
228 }
229
230 *kpp = NULL;
231}
static void key_free(struct PgpKeyInfo **ptr)
Free a PGP Key info.
Definition: pgplib.c:149
Information about a PGP key.
Definition: pgplib.h:47
struct PgpKeyInfo * next
Definition: pgplib.h:57
struct PgpKeyInfo * parent
Definition: pgplib.h:56
+ 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]klistList of PGP Keys
[in]keyKey to remove
Return values
ptrUpdated list of PGP Keys

Definition at line 169 of file pgplib.c.

170{
171 if (!klist || !*klist || !key)
172 return NULL;
173
174 struct PgpKeyInfo **last = NULL;
175 struct PgpKeyInfo *p = NULL, *q = NULL, *r = NULL;
176
177 if (key->parent && (key->parent != key))
178 key = key->parent;
179
180 last = klist;
181 for (p = *klist; p && p != key; p = p->next)
182 last = &p->next;
183
184 if (!p)
185 return NULL;
186
187 for (q = p->next, r = p; q && q->parent == p; q = q->next)
188 r = q;
189
190 if (r)
191 r->next = NULL;
192
193 *last = q;
194 return q;
195}
+ Here is the caller graph for this function:

◆ pgp_keyinfo_new()

struct PgpKeyInfo * pgp_keyinfo_new ( void  )