1 This is gpgme.info, produced by makeinfo version 6.3 from gpgme.texi.
3 Copyright © 2002–2008, 2010, 2012–2018 g10 Code GmbH.
5 Permission is granted to copy, distribute and/or modify this
6 document under the terms of the GNU General Public License as
7 published by the Free Software Foundation; either version 3 of the
8 License, or (at your option) any later version. The text of the
9 license can be found in the section entitled “Copying”.
11 This document is distributed in the hope that it will be useful, but
12 WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General
14 Public License for more details.
15 INFO-DIR-SECTION GNU Libraries
17 * GPGME: (gpgme). Adding support for cryptography to your program.
20 This file documents the GPGME library.
22 This is Edition 1.12.1-beta100, last updated 3 December 2018, of ‘The
23 ‘GnuPG Made Easy’ Reference Manual’, for Version 1.12.1-beta100.
25 Copyright © 2002–2008, 2010, 2012–2018 g10 Code GmbH.
27 Permission is granted to copy, distribute and/or modify this
28 document under the terms of the GNU General Public License as
29 published by the Free Software Foundation; either version 3 of the
30 License, or (at your option) any later version. The text of the
31 license can be found in the section entitled “Copying”.
33 This document is distributed in the hope that it will be useful, but
34 WITHOUT ANY WARRANTY; without even the implied warranty of
35 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General
36 Public License for more details.
39 File: gpgme.info, Node: UI Server Verify, Next: UI Server Set Input Files, Prev: UI Server Decrypt, Up: UI Server Protocol
41 A.4 UI Server: Verify a Message
42 ===============================
44 The server needs to support the verification of opaque signatures as
45 well as detached signatures. The kind of input sources controls what
46 kind message is to be verified.
48 -- Command: MESSAGE FD=N
49 This command is used with detached signatures to set the file
50 descriptor for the signed data to N. The data is binary encoded
51 (used verbatim). For details on the file descriptor, see the
52 description of ‘INPUT’ in the ‘ENCRYPT’ section.
54 -- Command: INPUT FD=N
55 Set the file descriptor for the opaque message or the signature
56 part of a detached signature to N. The message send to the server
57 is either binary encoded or – in the case of OpenPGP – ASCII
58 armored. For details on the file descriptor, see the description
59 of ‘INPUT’ in the ‘ENCRYPT’ section.
61 -- Command: OUTPUT FD=N
62 Set the file descriptor to be used for the output. The output is
63 binary encoded and only used for opaque signatures. For details on
64 the file descriptor, see the description of ‘INPUT’ in the
67 The verification is then started using:
69 -- Command: VERIFY --protocol=NAME [--silent]
70 NAME is the signing protocol used for the message. For a
71 description of the allowed protocols see the ‘ENCRYPT’ command.
72 This argument is mandatory. Depending on the combination of
73 ‘MESSAGE’ ‘INPUT’ and ‘OUTPUT’ commands, the server needs to select
74 the appropriate verification mode:
77 This indicates a detached signature. Output data is not
80 This indicates an opaque signature. As no output command has
81 been given, the server is only required to check the
84 This indicates an opaque signature. The server shall write
85 the signed data to the file descriptor set by the output
86 command. This data shall even be written if the signatures
89 With ‘--silent’ the server shall not display any dialog; this is for
90 example used by the client to get the content of opaque signed messages.
91 The client expects the server to send at least this status information
92 before the final OK response:
94 -- Status line: SIGSTATUS FLAG DISPLAYSTRING
95 Returns the status for the signature and a short string explaining
96 the status. Valid values for FLAG are:
99 The message has a signature but it could not not be verified
100 due to a missing key.
102 The signature is fully valid.
104 The signature is valid but additional information was shown
105 regarding the validity of the key.
107 The signature is not valid.
109 DISPLAYSTRING is a percent-and-plus-encoded string with a short
110 human readable description of the status. For example
112 S SIGSTATUS green Good+signature+from+Keith+Moon+<keith@example.net>
114 Note that this string needs to fit into an Assuan line and should
115 be short enough to be displayed as short one-liner on the clients
116 window. As usual the encoding of this string is UTF-8 and it
117 should be send in its translated form.
119 The server shall send one status line for every signature found on
123 File: gpgme.info, Node: UI Server Set Input Files, Next: UI Server Sign/Encrypt Files, Prev: UI Server Verify, Up: UI Server Protocol
125 A.5 UI Server: Specifying the input files to operate on.
126 ========================================================
128 All file related UI server commands operate on a number of input files
129 or directories, specified by one or more ‘FILE’ commands:
131 -- Command: FILE [--clear] NAME
132 Add the file or directory NAME to the list of pathnames to be
133 processed by the server. The parameter NAME must be an absolute
134 path name (including the drive letter) and is percent espaced (in
135 particular, the characters %, = and white space characters are
136 always escaped). If the option ‘--clear’ is given, the list of
137 files is cleared before adding NAME.
139 Historical note: The original spec did not define ‘--clear’ but the
140 keyword ‘--continued’ after the file name to indicate that more
141 files are to be expected. However, this has never been used and
142 thus removed from the specs.
145 File: gpgme.info, Node: UI Server Sign/Encrypt Files, Next: UI Server Verify/Decrypt Files, Prev: UI Server Set Input Files, Up: UI Server Protocol
147 A.6 UI Server: Encrypting and signing files.
148 ============================================
150 First, the input files need to be specified by one or more ‘FILE’
151 commands. Afterwards, the actual operation is requested:
153 -- Command: ENCRYPT_FILES --nohup
154 -- Command: SIGN_FILES --nohup
155 -- Command: ENCRYPT_SIGN_FILES --nohup
156 Request that the files specified by ‘FILE’ are encrypted and/or
157 signed. The command selects the default action. The UI server may
158 allow the user to change this default afterwards interactively, and
159 even abort the operation or complete it only on some of the
160 selected files and directories.
162 What it means to encrypt or sign a file or directory is specific to
163 the preferences of the user, the functionality the UI server
164 provides, and the selected protocol. Typically, for each input
165 file a new file is created under the original filename plus a
166 protocol specific extension (like ‘.gpg’ or ‘.sig’), which contain
167 the encrypted/signed file or a detached signature. For
168 directories, the server may offer multiple options to the user (for
169 example ignore or process recursively).
171 The ‘ENCRYPT_SIGN_FILES’ command requests a combined sign and
172 encrypt operation. It may not be available for all protocols (for
173 example, it is available for OpenPGP but not for CMS).
175 The option ‘--nohup’ is mandatory. It is currently unspecified
176 what should happen if ‘--nohup’ is not present. Because ‘--nohup’
177 is present, the server always returns ‘OK’ promptly, and completes
178 the operation asynchronously.
181 File: gpgme.info, Node: UI Server Verify/Decrypt Files, Next: UI Server Import/Export Keys, Prev: UI Server Sign/Encrypt Files, Up: UI Server Protocol
183 A.7 UI Server: Decrypting and verifying files.
184 ==============================================
186 First, the input files need to be specified by one or more ‘FILE’
187 commands. Afterwards, the actual operation is requested:
189 -- Command: DECRYPT_FILES --nohup
190 -- Command: VERIFY_FILES --nohup
191 -- Command: DECRYPT_VERIFY_FILES --nohup
192 Request that the files specified by ‘FILE’ are decrypted and/or
193 verified. The command selects the default action. The UI server
194 may allow the user to change this default afterwards interactively,
195 and even abort the operation or complete it only on some of the
196 selected files and directories.
198 What it means to decrypt or verify a file or directory is specific
199 to the preferences of the user, the functionality the UI server
200 provides, and the selected protocol. Typically, for decryption, a
201 new file is created for each input file under the original filename
202 minus a protocol specific extension (like ‘.gpg’) which contains
203 the original plaintext. For verification a status is displayed for
204 each signed input file, indicating if it is signed, and if yes, if
205 the signature is valid. For files that are signed and encrypted,
206 the ‘VERIFY’ command transiently decrypts the file to verify the
207 enclosed signature. For directories, the server may offer multiple
208 options to the user (for example ignore or process recursively).
210 The option ‘--nohup’ is mandatory. It is currently unspecified
211 what should happen if ‘--nohup’ is not present. Because ‘--nohup’
212 is present, the server always returns ‘OK’ promptly, and completes
213 the operation asynchronously.
216 File: gpgme.info, Node: UI Server Import/Export Keys, Next: UI Server Checksum Files, Prev: UI Server Verify/Decrypt Files, Up: UI Server Protocol
218 A.8 UI Server: Managing certificates.
219 =====================================
221 First, the input files need to be specified by one or more ‘FILE’
222 commands. Afterwards, the actual operation is requested:
224 -- Command: IMPORT_FILES --nohup
225 Request that the certificates contained in the files specified by
226 ‘FILE’ are imported into the local certificate databases.
228 For directories, the server may offer multiple options to the user
229 (for example ignore or process recursively).
231 The option ‘--nohup’ is mandatory. It is currently unspecified
232 what should happen if ‘--nohup’ is not present. Because ‘--nohup’
233 is present, the server always returns ‘OK’ promptly, and completes
234 the operation asynchronously.
236 FIXME: It may be nice to support an ‘EXPORT’ command as well, which
237 is enabled by the context menu of the background of a directory.
240 File: gpgme.info, Node: UI Server Checksum Files, Next: Miscellaneous UI Server Commands, Prev: UI Server Import/Export Keys, Up: UI Server Protocol
242 A.9 UI Server: Create and verify checksums for files.
243 =====================================================
245 First, the input files need to be specified by one or more ‘FILE’
246 commands. Afterwards, the actual operation is requested:
248 -- Command: CHECKSUM_CREATE_FILES --nohup
249 Request that checksums are created for the files specified by
250 ‘FILE’. The choice of checksum algorithm and the destination
251 storage and format for the created checksums depend on the
252 preferences of the user and the functionality provided by the UI
253 server. For directories, the server may offer multiple options to
254 the user (for example ignore or process recursively).
256 The option ‘--nohup’ is mandatory. It is currently unspecified
257 what should happen if ‘--nohup’ is not present. Because ‘--nohup’
258 is present, the server always returns ‘OK’ promptly, and completes
259 the operation asynchronously.
261 -- Command: CHECKSUM_VERIFY_FILES --nohup
262 Request that checksums are created for the files specified by
263 ‘FILE’ and verified against previously created and stored
264 checksums. The choice of checksum algorithm and the source storage
265 and format for previously created checksums depend on the
266 preferences of the user and the functionality provided by the UI
267 server. For directories, the server may offer multiple options to
268 the user (for example ignore or process recursively).
270 If the source storage of previously created checksums is available
271 to the user through the Windows shell, this command may also accept
272 such checksum files as ‘FILE’ arguments. In this case, the UI
273 server should instead verify the checksum of the referenced files
274 as if they were given as INPUT files.
276 The option ‘--nohup’ is mandatory. It is currently unspecified
277 what should happen if ‘--nohup’ is not present. Because ‘--nohup’
278 is present, the server always returns ‘OK’ promptly, and completes
279 the operation asynchronously.
282 File: gpgme.info, Node: Miscellaneous UI Server Commands, Prev: UI Server Checksum Files, Up: UI Server Protocol
284 A.10 Miscellaneous UI Server Commands
285 =====================================
287 The server needs to implement the following commands which are not
288 related to a specific command:
290 -- Command: GETINFO WHAT
291 This is a multi purpose command, commonly used to return a variety
292 of information. The required subcommands as described by the WHAT
296 Return the process id of the server in decimal notation using
299 To allow the server to pop up the windows in the correct relation to the
300 client, the client is advised to tell the server by sending the option:
302 -- Command option: window-id NUMBER
303 The NUMBER represents the native window ID of the clients current
304 window. On Windows systems this is a windows handle (‘HWND’) and
305 on X11 systems it is the ‘X Window ID’. The number needs to be
306 given as a hexadecimal value so that it is easier to convey pointer
307 values (e.g. ‘HWND’).
309 A client may want to fire up the certificate manager of the server. To
310 do this it uses the Assuan command:
312 -- Command: START_KEYMANAGER
313 The server shall pop up the main window of the key manager (aka
314 certificate manager). The client expects that the key manager is
315 brought into the foregound and that this command immediately
316 returns (does not wait until the key manager has been fully brought
319 A client may want to fire up the configuration dialog of the server. To
320 do this it uses the Assuan command:
322 -- Command: START_CONFDIALOG
323 The server shall pop up its configuration dialog. The client
324 expects that this dialog is brought into the foregound and that
325 this command immediately returns (i.e. it does not wait until the
326 dialog has been fully brought up).
328 When doing an operation on a mail, it is useful to let the server know
329 the address of the sender:
331 -- Command: SENDER [--info] [--protocol=NAME] EMAIL
332 EMAIL is the plain ASCII encoded address ("addr-spec" as per
333 RFC-2822) enclosed in angle brackets. The address set with this
334 command is valid until a successful completion of the operation or
335 until a ‘RESET’ command. A second command overrides the effect of
336 the first one; if EMAIL is not given and ‘--info’ is not used, the
337 server shall use the default signing key.
339 If option ‘--info’ is not given, the server shall also suggest a
340 protocol to use for signing. The client may use this suggested
341 protocol on its own discretion. The same status line as with
342 PREP_ENCRYPT is used for this.
344 The option ‘--protocol’ may be used to give the server a hint on
345 which signing protocol should be preferred.
347 To allow the UI-server to visually identify a running operation or to
348 associate operations the server MAY support the command:
350 -- Command: SESSION NUMBER [STRING]
351 The NUMBER is an arbitrary value, a server may use to associate
352 simultaneous running sessions. It is a 32 bit unsigned integer
353 with ‘0’ as a special value indicating that no session association
356 If STRING is given, the server may use this as the title of a
357 window or, in the case of an email operation, to extract the
358 sender’s address. The string may contain spaces; thus no
359 plus-escaping is used.
361 This command may be used at any time and overrides the effect of
362 the last command. A ‘RESET’ undoes the effect of this command.
365 File: gpgme.info, Node: Debugging, Next: Deprecated Functions, Prev: UI Server Protocol, Up: Top
367 Appendix B How to solve problems
368 ********************************
370 Everyone knows that software often does not do what it should do and
371 thus there is a need to track down problems. This is in particular true
372 for applications using a complex library like GPGME and of course also
373 for the library itself. Here we give a few hints on how to solve such
376 First of all you should make sure that the keys you want to use are
377 installed in the GnuPG engine and are usable. Thus the first test is to
378 run the desired operation using ‘gpg’ or ‘gpgsm’ on the command line.
379 If you can’t figure out why things don’t work, you may use GPGME’s built
380 in trace feature. This feature is either enabled using the environment
381 variable ‘GPGME_DEBUG’ or, if this is not possible, by calling the
382 function ‘gpgme_set_global_flag’. The value is the trace level and an
383 optional file name. If no file name is given the trace output is
387 GPGME_DEBUG=9:/home/user/mygpgme.log
388 (Note that under Windows you use a semicolon in place of the colon to
389 separate the fields.)
391 A trace level of 9 is pretty verbose and thus you may want to start
392 off with a lower level. The exact definition of the trace levels and
393 the output format may change with any release; you need to check the
394 source code for details. In any case the trace log should be helpful to
395 understand what is going going on. Warning: The trace log may reveal
396 sensitive details like passphrases or other data you use in your
397 application. If you are asked to send a log file, make sure that you
398 run your tests only with play data.
401 File: gpgme.info, Node: Deprecated Functions, Next: Library Copying, Prev: Debugging, Up: Top
403 Appendix C Deprecated Functions
404 *******************************
406 For backward compatibility GPGME has a number of functions, data types
407 and constants which are deprecated and should not be used anymore. We
408 document here those which are really old to help understanding old code
409 and to allow migration to their modern counterparts.
411 *Warning:* These interfaces will be removed in a future version of
414 -- Function: void gpgme_key_release (gpgme_key_t KEY)
415 The function ‘gpgme_key_release’ is equivalent to
418 -- Function: void gpgme_trust_item_release (gpgme_trust_item_t ITEM)
419 The function ‘gpgme_trust_item_release’ is an alias for
420 ‘gpgme_trust_item_unref’.
422 -- Function: gpgme_error_t gpgme_op_import_ext (gpgme_ctx_t CTX,
423 gpgme_data_t KEYDATA, int *NR)
426 The function ‘gpgme_op_import_ext’ is equivalent to:
428 gpgme_error_t err = gpgme_op_import (ctx, keydata);
431 gpgme_import_result_t result = gpgme_op_import_result (ctx);
432 *nr = result->considered;
435 -- Data type: gpgme_error_t (*gpgme_edit_cb_t) (void *HANDLE,
436 gpgme_status_code_t STATUS, const char *ARGS, int FD)
437 The ‘gpgme_edit_cb_t’ type is the type of functions which GPGME
438 calls if it a key edit operation is on-going. The status code
439 STATUS and the argument line ARGS are passed through by GPGME from
440 the crypto engine. The file descriptor FD is -1 for normal status
441 messages. If STATUS indicates a command rather than a status
442 message, the response to the command should be written to FD. The
443 HANDLE is provided by the user at start of operation.
445 The function should return ‘GPG_ERR_FALSE’ if it did not handle the
446 status code, ‘0’ for success, or any other error value.
448 -- Function: gpgme_error_t gpgme_op_edit (gpgme_ctx_t CTX,
449 gpgme_key_t KEY, gpgme_edit_cb_t FNC, void *HANDLE,
453 Note: This function is deprecated, please use ‘gpgme_op_interact’
456 The function ‘gpgme_op_edit’ processes the key KEY interactively,
457 using the edit callback function FNC with the handle HANDLE. The
458 callback is invoked for every status and command request from the
459 crypto engine. The output of the crypto engine is written to the
462 Note that the protocol between the callback function and the crypto
463 engine is specific to the crypto engine and no further support in
464 implementing this protocol correctly is provided by GPGME.
466 The function returns the error code ‘GPG_ERR_NO_ERROR’ if the edit
467 operation completes successfully, ‘GPG_ERR_INV_VALUE’ if CTX or KEY
468 is not a valid pointer, and any error returned by the crypto engine
469 or the edit callback handler.
471 -- Function: gpgme_error_t gpgme_op_edit_start (gpgme_ctx_t CTX,
472 gpgme_key_t KEY, gpgme_edit_cb_t FNC, void *HANDLE,
477 Note: This function is deprecated, please use
478 ‘gpgme_op_interact_start’ instead.
480 The function ‘gpgme_op_edit_start’ initiates a ‘gpgme_op_edit’
481 operation. It can be completed by calling ‘gpgme_wait’ on the
482 context. *Note Waiting For Completion::.
484 The function returns the error code ‘GPG_ERR_NO_ERROR’ if the
485 operation was started successfully, and ‘GPG_ERR_INV_VALUE’ if CTX
486 or KEY is not a valid pointer.
488 -- Function: gpgme_error_t gpgme_op_card_edit (gpgme_ctx_t CTX,
489 gpgme_key_t KEY, gpgme_edit_cb_t FNC, void *HANDLE,
491 Note: This function is deprecated, please use ‘gpgme_op_interact’
492 with the flag ‘GPGME_INTERACT_CARD’ instead.
494 The function ‘gpgme_op_card_edit’ is analogous to ‘gpgme_op_edit’,
495 but should be used to process the smart card corresponding to the
498 -- Function: gpgme_error_t gpgme_op_card_edit_start (gpgme_ctx_t CTX,
499 gpgme_key_t KEY, gpgme_edit_cb_t FNC, void *HANDLE,
501 Note: This function is deprecated, please use
502 ‘gpgme_op_interact_start’ with the flag ‘GPGME_INTERACT_CARD’
505 The function ‘gpgme_op_card_edit_start’ initiates a
506 ‘gpgme_op_card_edit’ operation. It can be completed by calling
507 ‘gpgme_wait’ on the context. *Note Waiting For Completion::.
509 The function returns the error code ‘GPG_ERR_NO_ERROR’ if the
510 operation was started successfully, and ‘GPG_ERR_INV_VALUE’ if CTX
511 or KEY is not a valid pointer.
513 -- Function: gpgme_error_t gpgme_data_new_with_read_cb
514 (gpgme_data_t *DH, int (*READFUNC) (void *HOOK, char *BUFFER,
515 size_t COUNT, size_t *NREAD), void *HOOK_VALUE)
516 The function ‘gpgme_data_new_with_read_cb’ creates a new
517 ‘gpgme_data_t’ object and uses the callback function READFUNC to
518 retrieve the data on demand. As the callback function can supply
519 the data in any way it wants, this is the most flexible data type
520 GPGME provides. However, it can not be used to write data.
522 The callback function receives HOOK_VALUE as its first argument
523 whenever it is invoked. It should return up to COUNT bytes in
524 BUFFER, and return the number of bytes actually read in NREAD. It
525 may return ‘0’ in NREAD if no data is currently available. To
526 indicate ‘EOF’ the function should return with an error code of
527 ‘-1’ and set NREAD to ‘0’. The callback function may support to
528 reset its internal read pointer if it is invoked with BUFFER and
529 NREAD being ‘NULL’ and COUNT being ‘0’.
531 The function returns the error code ‘GPG_ERR_NO_ERROR’ if the data
532 object was successfully created, ‘GPG_ERR_INV_VALUE’ if DH or
533 READFUNC is not a valid pointer, and ‘GPG_ERR_ENOMEM’ if not enough
536 -- Function: gpgme_error_t gpgme_data_rewind (gpgme_data_t DH)
537 The function ‘gpgme_data_rewind’ is equivalent to:
539 return (gpgme_data_seek (dh, 0, SEEK_SET) == -1)
540 ? gpgme_error_from_errno (errno) : 0;
542 -- Data type: gpgme_attr_t
543 The ‘gpgme_attr_t’ type is used to specify a key or trust item
544 attribute. The following attributes are defined:
547 This is the key ID of a sub key. It is representable as a
550 For trust items, the trust item refers to the key with this
554 This is the fingerprint of a sub key. It is representable as
558 This is the crypto algorithm for which the sub key can be
559 used. It is representable as a string and as a number. The
560 numbers correspond to the ‘enum gcry_pk_algos’ values in the
564 This is the key length of a sub key. It is representable as a
568 This is the timestamp at creation time of a sub key. It is
569 representable as a number.
572 This is the expiration time of a sub key. It is representable
576 XXX FIXME (also for trust items)
579 This is a user ID. There can be more than one user IDs in a
580 GPGME_KEY_T object. The first one (with index 0) is the
581 primary user ID. The user ID is representable as a number.
583 For trust items, this is the user ID associated with this
587 This is the name belonging to a user ID. It is representable
591 This is the email address belonging to a user ID. It is
592 representable as a string.
595 This is the comment belonging to a user ID. It is
596 representable as a string.
598 ‘GPGME_ATTR_VALIDITY’
599 This is the validity belonging to a user ID. It is
600 representable as a string and as a number. See below for a
601 list of available validities.
603 For trust items, this is the validity that is associated with
606 ‘GPGME_ATTR_UID_REVOKED’
607 This specifies if a user ID is revoked. It is representable
608 as a number, and is ‘1’ if the user ID is revoked, and ‘0’
611 ‘GPGME_ATTR_UID_INVALID’
612 This specifies if a user ID is invalid. It is representable
613 as a number, and is ‘1’ if the user ID is invalid, and ‘0’
617 This is the trust level of a trust item.
620 This returns information about the type of key. For the
621 string function this will eother be "PGP" or "X.509". The
622 integer function returns 0 for PGP and 1 for X.509. It is
623 also used for the type of a trust item.
625 ‘GPGME_ATTR_IS_SECRET’
626 This specifies if the key is a secret key. It is
627 representable as a number, and is ‘1’ if the key is revoked,
630 ‘GPGME_ATTR_KEY_REVOKED’
631 This specifies if a sub key is revoked. It is representable
632 as a number, and is ‘1’ if the key is revoked, and ‘0’
635 ‘GPGME_ATTR_KEY_INVALID’
636 This specifies if a sub key is invalid. It is representable
637 as a number, and is ‘1’ if the key is invalid, and ‘0’
640 ‘GPGME_ATTR_KEY_EXPIRED’
641 This specifies if a sub key is expired. It is representable
642 as a number, and is ‘1’ if the key is expired, and ‘0’
645 ‘GPGME_ATTR_KEY_DISABLED’
646 This specifies if a sub key is disabled. It is representable
647 as a number, and is ‘1’ if the key is disabled, and ‘0’
650 ‘GPGME_ATTR_KEY_CAPS’
651 This is a description of the capabilities of a sub key. It is
652 representable as a string. The string contains the letter “e”
653 if the key can be used for encryption, “s” if the key can be
654 used for signatures, and “c” if the key can be used for
657 ‘GPGME_ATTR_CAN_ENCRYPT’
658 This specifies if a sub key can be used for encryption. It is
659 representable as a number, and is ‘1’ if the sub key can be
660 used for encryption, and ‘0’ otherwise.
662 ‘GPGME_ATTR_CAN_SIGN’
663 This specifies if a sub key can be used to create data
664 signatures. It is representable as a number, and is ‘1’ if
665 the sub key can be used for signatures, and ‘0’ otherwise.
667 ‘GPGME_ATTR_CAN_CERTIFY’
668 This specifies if a sub key can be used to create key
669 certificates. It is representable as a number, and is ‘1’ if
670 the sub key can be used for certifications, and ‘0’ otherwise.
673 The X.509 issuer serial attribute of the key. It is
674 representable as a string.
677 The X.509 issuer name attribute of the key. It is
678 representable as a string.
681 The X.509 chain ID can be used to build the certification
682 chain. It is representable as a string.
684 -- Function: const char * gpgme_key_get_string_attr (gpgme_key_t KEY,
685 gpgme_attr_t WHAT, const void *RESERVED, int IDX)
686 The function ‘gpgme_key_get_string_attr’ returns the value of the
687 string-representable attribute WHAT of key KEY. If the attribute
688 is an attribute of a sub key or an user ID, IDX specifies the sub
689 key or user ID of which the attribute value is returned. The
690 argument RESERVED is reserved for later use and should be ‘NULL’.
692 The string returned is only valid as long as the key is valid.
694 The function returns ‘0’ if an attribute can’t be returned as a
695 string, KEY is not a valid pointer, IDX out of range, or RESERVED
698 -- Function: unsigned long gpgme_key_get_ulong_attr (gpgme_key_t KEY,
699 gpgme_attr_t WHAT, const void *RESERVED, int IDX)
700 The function ‘gpgme_key_get_ulong_attr’ returns the value of the
701 number-representable attribute WHAT of key KEY. If the attribute
702 is an attribute of a sub key or an user ID, IDX specifies the sub
703 key or user ID of which the attribute value is returned. The
704 argument RESERVED is reserved for later use and should be ‘NULL’.
706 The function returns ‘0’ if the attribute can’t be returned as a
707 number, KEY is not a valid pointer, IDX out of range, or RESERVED
710 The signatures on a key are only available if the key was retrieved
711 via a listing operation with the ‘GPGME_KEYLIST_MODE_SIGS’ mode enabled,
712 because it is expensive to retrieve all signatures of a key.
714 So, before using the below interfaces to retrieve the signatures on a
715 key, you have to make sure that the key was listed with signatures
716 enabled. One convenient, but blocking, way to do this is to use the
717 function ‘gpgme_get_key’.
719 -- Data type: gpgme_attr_t
720 The ‘gpgme_attr_t’ type is used to specify a key signature
721 attribute. The following attributes are defined:
724 This is the key ID of the key which was used for the
725 signature. It is representable as a string.
728 This is the crypto algorithm used to create the signature. It
729 is representable as a string and as a number. The numbers
730 correspond to the ‘enum gcry_pk_algos’ values in the gcrypt
734 This is the timestamp at creation time of the signature. It
735 is representable as a number.
738 This is the expiration time of the signature. It is
739 representable as a number.
742 This is the user ID associated with the signing key. The user
743 ID is representable as a number.
746 This is the name belonging to a user ID. It is representable
750 This is the email address belonging to a user ID. It is
751 representable as a string.
754 This is the comment belonging to a user ID. It is
755 representable as a string.
757 ‘GPGME_ATTR_KEY_REVOKED’
758 This specifies if a key signature is a revocation signature.
759 It is representable as a number, and is ‘1’ if the key is
760 revoked, and ‘0’ otherwise.
762 ‘GPGME_ATTR_SIG_CLASS’
763 This specifies the signature class of a key signature. It is
764 representable as a number. The meaning is specific to the
767 ‘GPGME_ATTR_SIG_CLASS’
768 This specifies the signature class of a key signature. It is
769 representable as a number. The meaning is specific to the
772 ‘GPGME_ATTR_SIG_STATUS’
773 This is the same value as returned by ‘gpgme_get_sig_status’.
775 -- Function: const char * gpgme_key_sig_get_string_attr
776 (gpgme_key_t KEY, int UID_IDX, gpgme_attr_t WHAT,
777 const void *RESERVED, int IDX)
778 The function ‘gpgme_key_sig_get_string_attr’ returns the value of
779 the string-representable attribute WHAT of the signature IDX on the
780 user ID UID_IDX in the key KEY. The argument RESERVED is reserved
781 for later use and should be ‘NULL’.
783 The string returned is only valid as long as the key is valid.
785 The function returns ‘0’ if an attribute can’t be returned as a
786 string, KEY is not a valid pointer, UID_IDX or IDX out of range, or
789 -- Function: unsigned long gpgme_key_sig_get_ulong_attr
790 (gpgme_key_t KEY, int UID_IDX, gpgme_attr_t WHAT,
791 const void *RESERVED, int IDX)
792 The function ‘gpgme_key_sig_get_ulong_attr’ returns the value of
793 the number-representable attribute WHAT of the signature IDX on the
794 user ID UID_IDX in the key KEY. The argument RESERVED is reserved
795 for later use and should be ‘NULL’.
797 The function returns ‘0’ if an attribute can’t be returned as a
798 string, KEY is not a valid pointer, UID_IDX or IDX out of range, or
801 Trust items have attributes which can be queried using the interfaces
802 below. The attribute identifiers are shared with those for key
803 attributes. *Note Information About Keys::.
805 -- Function: const char * gpgme_trust_item_get_string_attr
806 (gpgme_trust_item_t ITEM, gpgme_attr_t WHAT,
807 const void *RESERVED, int IDX)
808 The function ‘gpgme_trust_item_get_string_attr’ returns the value
809 of the string-representable attribute WHAT of trust item ITEM. The
810 arguments IDX and RESERVED are reserved for later use and should be
811 ‘0’ and ‘NULL’ respectively.
813 The string returned is only valid as long as the key is valid.
815 The function returns ‘0’ if an attribute can’t be returned as a
816 string, KEY is not a valid pointer, IDX out of range, or RESERVED
819 -- Function: int gpgme_trust_item_get_int_attr
820 (gpgme_trust_item_t ITEM, gpgme_attr_t WHAT,
821 const void *RESERVED, int IDX)
822 The function ‘gpgme_trust_item_get_int_attr’ returns the value of
823 the number-representable attribute WHAT of trust item ITEM. If the
824 attribute occurs more than once in the trust item, the index is
825 specified by IDX. However, currently no such attribute exists, so
826 IDX should be ‘0’. The argument RESERVED is reserved for later use
827 and should be ‘NULL’.
829 The function returns ‘0’ if the attribute can’t be returned as a
830 number, KEY is not a valid pointer, IDX out of range, or RESERVED
833 -- Data type: enum gpgme_sig_stat_t
834 The ‘gpgme_sig_stat_t’ type holds the result of a signature check,
835 or the combined result of all signatures. The following results
838 ‘GPGME_SIG_STAT_NONE’
839 This status should not occur in normal operation.
841 ‘GPGME_SIG_STAT_GOOD’
842 This status indicates that the signature is valid. For the
843 combined result this status means that all signatures are
846 ‘GPGME_SIG_STAT_GOOD_EXP’
847 This status indicates that the signature is valid but expired.
848 For the combined result this status means that all signatures
849 are valid and expired.
851 ‘GPGME_SIG_STAT_GOOD_EXPKEY’
852 This status indicates that the signature is valid but the key
853 used to verify the signature has expired. For the combined
854 result this status means that all signatures are valid and all
858 This status indicates that the signature is invalid. For the
859 combined result this status means that all signatures are
862 ‘GPGME_SIG_STAT_NOKEY’
863 This status indicates that the signature could not be verified
864 due to a missing key. For the combined result this status
865 means that all signatures could not be checked due to missing
868 ‘GPGME_SIG_STAT_NOSIG’
869 This status indicates that the signature data provided was not
872 ‘GPGME_SIG_STAT_ERROR’
873 This status indicates that there was some other error which
874 prevented the signature verification.
876 ‘GPGME_SIG_STAT_DIFF’
877 For the combined result this status means that at least two
878 signatures have a different status. You can get each key’s
879 status with ‘gpgme_get_sig_status’.
881 -- Function: const char * gpgme_get_sig_status (gpgme_ctx_t CTX,
882 int IDX, gpgme_sig_stat_t *R_STAT, time_t *R_CREATED)
883 The function ‘gpgme_get_sig_status’ is equivalent to:
885 gpgme_verify_result_t result;
886 gpgme_signature_t sig;
888 result = gpgme_op_verify_result (ctx);
889 sig = result->signatures;
901 switch (gpg_err_code (sig->status))
903 case GPG_ERR_NO_ERROR:
904 *r_stat = GPGME_SIG_STAT_GOOD;
907 case GPG_ERR_BAD_SIGNATURE:
908 *r_stat = GPGME_SIG_STAT_BAD;
911 case GPG_ERR_NO_PUBKEY:
912 *r_stat = GPGME_SIG_STAT_NOKEY;
915 case GPG_ERR_NO_DATA:
916 *r_stat = GPGME_SIG_STAT_NOSIG;
919 case GPG_ERR_SIG_EXPIRED:
920 *r_stat = GPGME_SIG_STAT_GOOD_EXP;
923 case GPG_ERR_KEY_EXPIRED:
924 *r_stat = GPGME_SIG_STAT_GOOD_EXPKEY;
928 *r_stat = GPGME_SIG_STAT_ERROR;
933 *r_created = sig->timestamp;
936 -- Function: const char * gpgme_get_sig_string_attr (gpgme_ctx_t CTX,
937 int IDX, gpgme_attr_t WHAT, int WHATIDX)
938 The function ‘gpgme_get_sig_string_attr’ is equivalent to:
940 gpgme_verify_result_t result;
941 gpgme_signature_t sig;
943 result = gpgme_op_verify_result (ctx);
944 sig = result->signatures;
959 case GPGME_ATTR_ERRTOK:
961 return sig->wrong_key_usage ? "Wrong_Key_Usage" : "";
970 -- Function: const char * gpgme_get_sig_ulong_attr (gpgme_ctx_t CTX,
971 int IDX, gpgme_attr_t WHAT, int WHATIDX)
972 The function ‘gpgme_get_sig_ulong_attr’ is equivalent to:
974 gpgme_verify_result_t result;
975 gpgme_signature_t sig;
977 result = gpgme_op_verify_result (ctx);
978 sig = result->signatures;
990 case GPGME_ATTR_CREATED:
991 return sig->timestamp;
993 case GPGME_ATTR_EXPIRE:
994 return sig->exp_timestamp;
996 case GPGME_ATTR_VALIDITY:
997 return (unsigned long) sig->validity;
999 case GPGME_ATTR_SIG_STATUS:
1000 switch (sig->status)
1002 case GPG_ERR_NO_ERROR:
1003 return GPGME_SIG_STAT_GOOD;
1005 case GPG_ERR_BAD_SIGNATURE:
1006 return GPGME_SIG_STAT_BAD;
1008 case GPG_ERR_NO_PUBKEY:
1009 return GPGME_SIG_STAT_NOKEY;
1011 case GPG_ERR_NO_DATA:
1012 return GPGME_SIG_STAT_NOSIG;
1014 case GPG_ERR_SIG_EXPIRED:
1015 return GPGME_SIG_STAT_GOOD_EXP;
1017 case GPG_ERR_KEY_EXPIRED:
1018 return GPGME_SIG_STAT_GOOD_EXPKEY;
1021 return GPGME_SIG_STAT_ERROR;
1024 case GPGME_ATTR_SIG_SUMMARY:
1025 return sig->summary;
1032 -- Function: const char * gpgme_get_sig_key (gpgme_ctx_t CTX, int IDX,
1034 The function ‘gpgme_get_sig_key’ is equivalent to:
1036 gpgme_verify_result_t result;
1037 gpgme_signature_t sig;
1039 result = gpgme_op_verify_result (ctx);
1040 sig = result->signatures;
1048 return gpg_error (GPG_ERR_EOF);
1050 return gpgme_get_key (ctx, sig->fpr, r_key, 0);
1053 File: gpgme.info, Node: Library Copying, Next: Copying, Prev: Deprecated Functions, Up: Top
1055 GNU Lesser General Public License
1056 *********************************
1058 Version 2.1, February 1999
1060 Copyright © 1991, 1999 Free Software Foundation, Inc.
1061 59 Temple Place – Suite 330, Boston, MA 02111-1307, USA
1063 Everyone is permitted to copy and distribute verbatim copies
1064 of this license document, but changing it is not allowed.
1066 [This is the first released version of the Lesser GPL. It also counts
1067 as the successor of the GNU Library Public License, version 2, hence the
1068 version number 2.1.]
1073 The licenses for most software are designed to take away your freedom to
1074 share and change it. By contrast, the GNU General Public Licenses are
1075 intended to guarantee your freedom to share and change free software—to
1076 make sure the software is free for all its users.
1078 This license, the Lesser General Public License, applies to some
1079 specially designated software—typically libraries—of the Free Software
1080 Foundation and other authors who decide to use it. You can use it too,
1081 but we suggest you first think carefully about whether this license or
1082 the ordinary General Public License is the better strategy to use in any
1083 particular case, based on the explanations below.
1085 When we speak of free software, we are referring to freedom of use,
1086 not price. Our General Public Licenses are designed to make sure that
1087 you have the freedom to distribute copies of free software (and charge
1088 for this service if you wish); that you receive source code or can get
1089 it if you want it; that you can change the software and use pieces of it
1090 in new free programs; and that you are informed that you can do these
1093 To protect your rights, we need to make restrictions that forbid
1094 distributors to deny you these rights or to ask you to surrender these
1095 rights. These restrictions translate to certain responsibilities for
1096 you if you distribute copies of the library or if you modify it.
1098 For example, if you distribute copies of the library, whether gratis
1099 or for a fee, you must give the recipients all the rights that we gave
1100 you. You must make sure that they, too, receive or can get the source
1101 code. If you link other code with the library, you must provide
1102 complete object files to the recipients, so that they can relink them
1103 with the library after making changes to the library and recompiling it.
1104 And you must show them these terms so they know their rights.
1106 We protect your rights with a two-step method: (1) we copyright the
1107 library, and (2) we offer you this license, which gives you legal
1108 permission to copy, distribute and/or modify the library.
1110 To protect each distributor, we want to make it very clear that there
1111 is no warranty for the free library. Also, if the library is modified
1112 by someone else and passed on, the recipients should know that what they
1113 have is not the original version, so that the original author’s
1114 reputation will not be affected by problems that might be introduced by
1117 Finally, software patents pose a constant threat to the existence of
1118 any free program. We wish to make sure that a company cannot
1119 effectively restrict the users of a free program by obtaining a
1120 restrictive license from a patent holder. Therefore, we insist that any
1121 patent license obtained for a version of the library must be consistent
1122 with the full freedom of use specified in this license.
1124 Most GNU software, including some libraries, is covered by the
1125 ordinary GNU General Public License. This license, the GNU Lesser
1126 General Public License, applies to certain designated libraries, and is
1127 quite different from the ordinary General Public License. We use this
1128 license for certain libraries in order to permit linking those libraries
1129 into non-free programs.
1131 When a program is linked with a library, whether statically or using
1132 a shared library, the combination of the two is legally speaking a
1133 combined work, a derivative of the original library. The ordinary
1134 General Public License therefore permits such linking only if the entire
1135 combination fits its criteria of freedom. The Lesser General Public
1136 License permits more lax criteria for linking other code with the
1139 We call this license the “Lesser” General Public License because it
1140 does _Less_ to protect the user’s freedom than the ordinary General
1141 Public License. It also provides other free software developers Less of
1142 an advantage over competing non-free programs. These disadvantages are
1143 the reason we use the ordinary General Public License for many
1144 libraries. However, the Lesser license provides advantages in certain
1145 special circumstances.
1147 For example, on rare occasions, there may be a special need to
1148 encourage the widest possible use of a certain library, so that it
1149 becomes a de-facto standard. To achieve this, non-free programs must be
1150 allowed to use the library. A more frequent case is that a free library
1151 does the same job as widely used non-free libraries. In this case,
1152 there is little to gain by limiting the free library to free software
1153 only, so we use the Lesser General Public License.
1155 In other cases, permission to use a particular library in non-free
1156 programs enables a greater number of people to use a large body of free
1157 software. For example, permission to use the GNU C Library in non-free
1158 programs enables many more people to use the whole GNU operating system,
1159 as well as its variant, the GNU/Linux operating system.
1161 Although the Lesser General Public License is Less protective of the
1162 users’ freedom, it does ensure that the user of a program that is linked
1163 with the Library has the freedom and the wherewithal to run that program
1164 using a modified version of the Library.
1166 The precise terms and conditions for copying, distribution and
1167 modification follow. Pay close attention to the difference between a
1168 “work based on the library” and a “work that uses the library”. The
1169 former contains code derived from the library, whereas the latter must
1170 be combined with the library in order to run.
1172 GNU LESSER GENERAL PUBLIC LICENSE
1173 TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
1175 0. This License Agreement applies to any software library or other
1176 program which contains a notice placed by the copyright holder or
1177 other authorized party saying it may be distributed under the terms
1178 of this Lesser General Public License (also called “this License”).
1179 Each licensee is addressed as “you”.
1181 A “library” means a collection of software functions and/or data
1182 prepared so as to be conveniently linked with application programs
1183 (which use some of those functions and data) to form executables.
1185 The “Library”, below, refers to any such software library or work
1186 which has been distributed under these terms. A “work based on the
1187 Library” means either the Library or any derivative work under
1188 copyright law: that is to say, a work containing the Library or a
1189 portion of it, either verbatim or with modifications and/or
1190 translated straightforwardly into another language. (Hereinafter,
1191 translation is included without limitation in the term
1194 “Source code” for a work means the preferred form of the work for
1195 making modifications to it. For a library, complete source code
1196 means all the source code for all modules it contains, plus any
1197 associated interface definition files, plus the scripts used to
1198 control compilation and installation of the library.
1200 Activities other than copying, distribution and modification are
1201 not covered by this License; they are outside its scope. The act
1202 of running a program using the Library is not restricted, and
1203 output from such a program is covered only if its contents
1204 constitute a work based on the Library (independent of the use of
1205 the Library in a tool for writing it). Whether that is true
1206 depends on what the Library does and what the program that uses the
1209 1. You may copy and distribute verbatim copies of the Library’s
1210 complete source code as you receive it, in any medium, provided
1211 that you conspicuously and appropriately publish on each copy an
1212 appropriate copyright notice and disclaimer of warranty; keep
1213 intact all the notices that refer to this License and to the
1214 absence of any warranty; and distribute a copy of this License
1215 along with the Library.
1217 You may charge a fee for the physical act of transferring a copy,
1218 and you may at your option offer warranty protection in exchange
1221 2. You may modify your copy or copies of the Library or any portion of
1222 it, thus forming a work based on the Library, and copy and
1223 distribute such modifications or work under the terms of Section 1
1224 above, provided that you also meet all of these conditions:
1226 a. The modified work must itself be a software library.
1228 b. You must cause the files modified to carry prominent notices
1229 stating that you changed the files and the date of any change.
1231 c. You must cause the whole of the work to be licensed at no
1232 charge to all third parties under the terms of this License.
1234 d. If a facility in the modified Library refers to a function or
1235 a table of data to be supplied by an application program that
1236 uses the facility, other than as an argument passed when the
1237 facility is invoked, then you must make a good faith effort to
1238 ensure that, in the event an application does not supply such
1239 function or table, the facility still operates, and performs
1240 whatever part of its purpose remains meaningful.
1242 (For example, a function in a library to compute square roots
1243 has a purpose that is entirely well-defined independent of the
1244 application. Therefore, Subsection 2d requires that any
1245 application-supplied function or table used by this function
1246 must be optional: if the application does not supply it, the
1247 square root function must still compute square roots.)
1249 These requirements apply to the modified work as a whole. If
1250 identifiable sections of that work are not derived from the
1251 Library, and can be reasonably considered independent and separate
1252 works in themselves, then this License, and its terms, do not apply
1253 to those sections when you distribute them as separate works. But
1254 when you distribute the same sections as part of a whole which is a
1255 work based on the Library, the distribution of the whole must be on
1256 the terms of this License, whose permissions for other licensees
1257 extend to the entire whole, and thus to each and every part
1258 regardless of who wrote it.
1260 Thus, it is not the intent of this section to claim rights or
1261 contest your rights to work written entirely by you; rather, the
1262 intent is to exercise the right to control the distribution of
1263 derivative or collective works based on the Library.
1265 In addition, mere aggregation of another work not based on the
1266 Library with the Library (or with a work based on the Library) on a
1267 volume of a storage or distribution medium does not bring the other
1268 work under the scope of this License.
1270 3. You may opt to apply the terms of the ordinary GNU General Public
1271 License instead of this License to a given copy of the Library. To
1272 do this, you must alter all the notices that refer to this License,
1273 so that they refer to the ordinary GNU General Public License,
1274 version 2, instead of to this License. (If a newer version than
1275 version 2 of the ordinary GNU General Public License has appeared,
1276 then you can specify that version instead if you wish.) Do not
1277 make any other change in these notices.
1279 Once this change is made in a given copy, it is irreversible for
1280 that copy, so the ordinary GNU General Public License applies to
1281 all subsequent copies and derivative works made from that copy.
1283 This option is useful when you wish to copy part of the code of the
1284 Library into a program that is not a library.
1286 4. You may copy and distribute the Library (or a portion or derivative
1287 of it, under Section 2) in object code or executable form under the
1288 terms of Sections 1 and 2 above provided that you accompany it with
1289 the complete corresponding machine-readable source code, which must
1290 be distributed under the terms of Sections 1 and 2 above on a
1291 medium customarily used for software interchange.
1293 If distribution of object code is made by offering access to copy
1294 from a designated place, then offering equivalent access to copy
1295 the source code from the same place satisfies the requirement to
1296 distribute the source code, even though third parties are not
1297 compelled to copy the source along with the object code.
1299 5. A program that contains no derivative of any portion of the
1300 Library, but is designed to work with the Library by being compiled
1301 or linked with it, is called a “work that uses the Library”. Such
1302 a work, in isolation, is not a derivative work of the Library, and
1303 therefore falls outside the scope of this License.
1305 However, linking a “work that uses the Library” with the Library
1306 creates an executable that is a derivative of the Library (because
1307 it contains portions of the Library), rather than a “work that uses
1308 the library”. The executable is therefore covered by this License.
1309 Section 6 states terms for distribution of such executables.
1311 When a “work that uses the Library” uses material from a header
1312 file that is part of the Library, the object code for the work may
1313 be a derivative work of the Library even though the source code is
1314 not. Whether this is true is especially significant if the work
1315 can be linked without the Library, or if the work is itself a
1316 library. The threshold for this to be true is not precisely
1319 If such an object file uses only numerical parameters, data
1320 structure layouts and accessors, and small macros and small inline
1321 functions (ten lines or less in length), then the use of the object
1322 file is unrestricted, regardless of whether it is legally a
1323 derivative work. (Executables containing this object code plus
1324 portions of the Library will still fall under Section 6.)
1326 Otherwise, if the work is a derivative of the Library, you may
1327 distribute the object code for the work under the terms of Section
1328 6. Any executables containing that work also fall under Section 6,
1329 whether or not they are linked directly with the Library itself.
1331 6. As an exception to the Sections above, you may also combine or link
1332 a “work that uses the Library” with the Library to produce a work
1333 containing portions of the Library, and distribute that work under
1334 terms of your choice, provided that the terms permit modification
1335 of the work for the customer’s own use and reverse engineering for
1336 debugging such modifications.
1338 You must give prominent notice with each copy of the work that the
1339 Library is used in it and that the Library and its use are covered
1340 by this License. You must supply a copy of this License. If the
1341 work during execution displays copyright notices, you must include
1342 the copyright notice for the Library among them, as well as a
1343 reference directing the user to the copy of this License. Also,
1344 you must do one of these things:
1346 a. Accompany the work with the complete corresponding
1347 machine-readable source code for the Library including
1348 whatever changes were used in the work (which must be
1349 distributed under Sections 1 and 2 above); and, if the work is
1350 an executable linked with the Library, with the complete
1351 machine-readable “work that uses the Library”, as object code
1352 and/or source code, so that the user can modify the Library
1353 and then relink to produce a modified executable containing
1354 the modified Library. (It is understood that the user who
1355 changes the contents of definitions files in the Library will
1356 not necessarily be able to recompile the application to use
1357 the modified definitions.)
1359 b. Use a suitable shared library mechanism for linking with the
1360 Library. A suitable mechanism is one that (1) uses at run
1361 time a copy of the library already present on the user’s
1362 computer system, rather than copying library functions into
1363 the executable, and (2) will operate properly with a modified
1364 version of the library, if the user installs one, as long as
1365 the modified version is interface-compatible with the version
1366 that the work was made with.
1368 c. Accompany the work with a written offer, valid for at least
1369 three years, to give the same user the materials specified in
1370 Subsection 6a, above, for a charge no more than the cost of
1371 performing this distribution.
1373 d. If distribution of the work is made by offering access to copy
1374 from a designated place, offer equivalent access to copy the
1375 above specified materials from the same place.
1377 e. Verify that the user has already received a copy of these
1378 materials or that you have already sent this user a copy.
1380 For an executable, the required form of the “work that uses the
1381 Library” must include any data and utility programs needed for
1382 reproducing the executable from it. However, as a special
1383 exception, the materials to be distributed need not include
1384 anything that is normally distributed (in either source or binary
1385 form) with the major components (compiler, kernel, and so on) of
1386 the operating system on which the executable runs, unless that
1387 component itself accompanies the executable.
1389 It may happen that this requirement contradicts the license
1390 restrictions of other proprietary libraries that do not normally
1391 accompany the operating system. Such a contradiction means you
1392 cannot use both them and the Library together in an executable that
1395 7. You may place library facilities that are a work based on the
1396 Library side-by-side in a single library together with other
1397 library facilities not covered by this License, and distribute such
1398 a combined library, provided that the separate distribution of the
1399 work based on the Library and of the other library facilities is
1400 otherwise permitted, and provided that you do these two things:
1402 a. Accompany the combined library with a copy of the same work
1403 based on the Library, uncombined with any other library
1404 facilities. This must be distributed under the terms of the
1407 b. Give prominent notice with the combined library of the fact
1408 that part of it is a work based on the Library, and explaining
1409 where to find the accompanying uncombined form of the same
1412 8. You may not copy, modify, sublicense, link with, or distribute the
1413 Library except as expressly provided under this License. Any
1414 attempt otherwise to copy, modify, sublicense, link with, or
1415 distribute the Library is void, and will automatically terminate
1416 your rights under this License. However, parties who have received
1417 copies, or rights, from you under this License will not have their
1418 licenses terminated so long as such parties remain in full
1421 9. You are not required to accept this License, since you have not
1422 signed it. However, nothing else grants you permission to modify
1423 or distribute the Library or its derivative works. These actions
1424 are prohibited by law if you do not accept this License.
1425 Therefore, by modifying or distributing the Library (or any work
1426 based on the Library), you indicate your acceptance of this License
1427 to do so, and all its terms and conditions for copying,
1428 distributing or modifying the Library or works based on it.
1430 10. Each time you redistribute the Library (or any work based on the
1431 Library), the recipient automatically receives a license from the
1432 original licensor to copy, distribute, link with or modify the
1433 Library subject to these terms and conditions. You may not impose
1434 any further restrictions on the recipients’ exercise of the rights
1435 granted herein. You are not responsible for enforcing compliance
1436 by third parties with this License.
1438 11. If, as a consequence of a court judgment or allegation of patent
1439 infringement or for any other reason (not limited to patent
1440 issues), conditions are imposed on you (whether by court order,
1441 agreement or otherwise) that contradict the conditions of this
1442 License, they do not excuse you from the conditions of this
1443 License. If you cannot distribute so as to satisfy simultaneously
1444 your obligations under this License and any other pertinent
1445 obligations, then as a consequence you may not distribute the
1446 Library at all. For example, if a patent license would not permit
1447 royalty-free redistribution of the Library by all those who receive
1448 copies directly or indirectly through you, then the only way you
1449 could satisfy both it and this License would be to refrain entirely
1450 from distribution of the Library.
1452 If any portion of this section is held invalid or unenforceable
1453 under any particular circumstance, the balance of the section is
1454 intended to apply, and the section as a whole is intended to apply
1455 in other circumstances.
1457 It is not the purpose of this section to induce you to infringe any
1458 patents or other property right claims or to contest validity of
1459 any such claims; this section has the sole purpose of protecting
1460 the integrity of the free software distribution system which is
1461 implemented by public license practices. Many people have made
1462 generous contributions to the wide range of software distributed
1463 through that system in reliance on consistent application of that
1464 system; it is up to the author/donor to decide if he or she is
1465 willing to distribute software through any other system and a
1466 licensee cannot impose that choice.
1468 This section is intended to make thoroughly clear what is believed
1469 to be a consequence of the rest of this License.
1471 12. If the distribution and/or use of the Library is restricted in
1472 certain countries either by patents or by copyrighted interfaces,
1473 the original copyright holder who places the Library under this
1474 License may add an explicit geographical distribution limitation
1475 excluding those countries, so that distribution is permitted only
1476 in or among countries not thus excluded. In such case, this
1477 License incorporates the limitation as if written in the body of
1480 13. The Free Software Foundation may publish revised and/or new
1481 versions of the Lesser General Public License from time to time.
1482 Such new versions will be similar in spirit to the present version,
1483 but may differ in detail to address new problems or concerns.
1485 Each version is given a distinguishing version number. If the
1486 Library specifies a version number of this License which applies to
1487 it and “any later version”, you have the option of following the
1488 terms and conditions either of that version or of any later version
1489 published by the Free Software Foundation. If the Library does not
1490 specify a license version number, you may choose any version ever
1491 published by the Free Software Foundation.
1493 14. If you wish to incorporate parts of the Library into other free
1494 programs whose distribution conditions are incompatible with these,
1495 write to the author to ask for permission. For software which is
1496 copyrighted by the Free Software Foundation, write to the Free
1497 Software Foundation; we sometimes make exceptions for this. Our
1498 decision will be guided by the two goals of preserving the free
1499 status of all derivatives of our free software and of promoting the
1500 sharing and reuse of software generally.
1504 15. BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO
1505 WARRANTY FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE
1506 LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS
1507 AND/OR OTHER PARTIES PROVIDE THE LIBRARY “AS IS” WITHOUT WARRANTY
1508 OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT
1509 LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
1510 FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND
1511 PERFORMANCE OF THE LIBRARY IS WITH YOU. SHOULD THE LIBRARY PROVE
1512 DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR
1515 16. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN
1516 WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY
1517 MODIFY AND/OR REDISTRIBUTE THE LIBRARY AS PERMITTED ABOVE, BE
1518 LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL,
1519 INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR
1520 INABILITY TO USE THE LIBRARY (INCLUDING BUT NOT LIMITED TO LOSS OF
1521 DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU
1522 OR THIRD PARTIES OR A FAILURE OF THE LIBRARY TO OPERATE WITH ANY
1523 OTHER SOFTWARE), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN
1524 ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
1526 END OF TERMS AND CONDITIONS
1528 How to Apply These Terms to Your New Libraries
1529 ==============================================
1531 If you develop a new library, and you want it to be of the greatest
1532 possible use to the public, we recommend making it free software that
1533 everyone can redistribute and change. You can do so by permitting
1534 redistribution under these terms (or, alternatively, under the terms of
1535 the ordinary General Public License).
1537 To apply these terms, attach the following notices to the library.
1538 It is safest to attach them to the start of each source file to most
1539 effectively convey the exclusion of warranty; and each file should have
1540 at least the “copyright” line and a pointer to where the full notice is
1543 ONE LINE TO GIVE THE LIBRARY'S NAME AND AN IDEA OF WHAT IT DOES.
1544 Copyright (C) YEAR NAME OF AUTHOR
1546 This library is free software; you can redistribute it and/or modify it
1547 under the terms of the GNU Lesser General Public License as published by
1548 the Free Software Foundation; either version 2.1 of the License, or (at
1549 your option) any later version.
1551 This library is distributed in the hope that it will be useful, but
1552 WITHOUT ANY WARRANTY; without even the implied warranty of
1553 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
1554 Lesser General Public License for more details.
1556 You should have received a copy of the GNU Lesser General Public
1557 License along with this library; if not, write to the Free Software
1558 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307,
1561 Also add information on how to contact you by electronic and paper
1564 You should also get your employer (if you work as a programmer) or
1565 your school, if any, to sign a “copyright disclaimer” for the library,
1566 if necessary. Here is a sample; alter the names:
1568 Yoyodyne, Inc., hereby disclaims all copyright interest in the library
1569 `Frob' (a library for tweaking knobs) written by James Random Hacker.
1571 SIGNATURE OF TY COON, 1 April 1990
1572 Ty Coon, President of Vice
1574 That’s all there is to it!
1577 File: gpgme.info, Node: Copying, Next: Concept Index, Prev: Library Copying, Up: Top
1579 GNU General Public License
1580 **************************
1582 Version 3, 29 June 2007
1584 Copyright © 2007 Free Software Foundation, Inc. <https://fsf.org/>
1586 Everyone is permitted to copy and distribute verbatim copies of this
1587 license document, but changing it is not allowed.
1592 The GNU General Public License is a free, copyleft license for software
1593 and other kinds of works.
1595 The licenses for most software and other practical works are designed
1596 to take away your freedom to share and change the works. By contrast,
1597 the GNU General Public License is intended to guarantee your freedom to
1598 share and change all versions of a program–to make sure it remains free
1599 software for all its users. We, the Free Software Foundation, use the
1600 GNU General Public License for most of our software; it applies also to
1601 any other work released this way by its authors. You can apply it to
1604 When we speak of free software, we are referring to freedom, not
1605 price. Our General Public Licenses are designed to make sure that you
1606 have the freedom to distribute copies of free software (and charge for
1607 them if you wish), that you receive source code or can get it if you
1608 want it, that you can change the software or use pieces of it in new
1609 free programs, and that you know you can do these things.
1611 To protect your rights, we need to prevent others from denying you
1612 these rights or asking you to surrender the rights. Therefore, you have
1613 certain responsibilities if you distribute copies of the software, or if
1614 you modify it: responsibilities to respect the freedom of others.
1616 For example, if you distribute copies of such a program, whether
1617 gratis or for a fee, you must pass on to the recipients the same
1618 freedoms that you received. You must make sure that they, too, receive
1619 or can get the source code. And you must show them these terms so they
1622 Developers that use the GNU GPL protect your rights with two steps:
1623 (1) assert copyright on the software, and (2) offer you this License
1624 giving you legal permission to copy, distribute and/or modify it.
1626 For the developers’ and authors’ protection, the GPL clearly explains
1627 that there is no warranty for this free software. For both users’ and
1628 authors’ sake, the GPL requires that modified versions be marked as
1629 changed, so that their problems will not be attributed erroneously to
1630 authors of previous versions.
1632 Some devices are designed to deny users access to install or run
1633 modified versions of the software inside them, although the manufacturer
1634 can do so. This is fundamentally incompatible with the aim of
1635 protecting users’ freedom to change the software. The systematic
1636 pattern of such abuse occurs in the area of products for individuals to
1637 use, which is precisely where it is most unacceptable. Therefore, we
1638 have designed this version of the GPL to prohibit the practice for those
1639 products. If such problems arise substantially in other domains, we
1640 stand ready to extend this provision to those domains in future versions
1641 of the GPL, as needed to protect the freedom of users.
1643 Finally, every program is threatened constantly by software patents.
1644 States should not allow patents to restrict development and use of
1645 software on general-purpose computers, but in those that do, we wish to
1646 avoid the special danger that patents applied to a free program could
1647 make it effectively proprietary. To prevent this, the GPL assures that
1648 patents cannot be used to render the program non-free.
1650 The precise terms and conditions for copying, distribution and
1651 modification follow.
1653 TERMS AND CONDITIONS
1657 “This License” refers to version 3 of the GNU General Public
1660 “Copyright” also means copyright-like laws that apply to other
1661 kinds of works, such as semiconductor masks.
1663 “The Program” refers to any copyrightable work licensed under this
1664 License. Each licensee is addressed as “you”. “Licensees” and
1665 “recipients” may be individuals or organizations.
1667 To “modify” a work means to copy from or adapt all or part of the
1668 work in a fashion requiring copyright permission, other than the
1669 making of an exact copy. The resulting work is called a “modified
1670 version” of the earlier work or a work “based on” the earlier work.
1672 A “covered work” means either the unmodified Program or a work
1673 based on the Program.
1675 To “propagate” a work means to do anything with it that, without
1676 permission, would make you directly or secondarily liable for
1677 infringement under applicable copyright law, except executing it on
1678 a computer or modifying a private copy. Propagation includes
1679 copying, distribution (with or without modification), making
1680 available to the public, and in some countries other activities as
1683 To “convey” a work means any kind of propagation that enables other
1684 parties to make or receive copies. Mere interaction with a user
1685 through a computer network, with no transfer of a copy, is not
1688 An interactive user interface displays “Appropriate Legal Notices”
1689 to the extent that it includes a convenient and prominently visible
1690 feature that (1) displays an appropriate copyright notice, and (2)
1691 tells the user that there is no warranty for the work (except to
1692 the extent that warranties are provided), that licensees may convey
1693 the work under this License, and how to view a copy of this
1694 License. If the interface presents a list of user commands or
1695 options, such as a menu, a prominent item in the list meets this
1700 The “source code” for a work means the preferred form of the work
1701 for making modifications to it. “Object code” means any non-source
1704 A “Standard Interface” means an interface that either is an
1705 official standard defined by a recognized standards body, or, in
1706 the case of interfaces specified for a particular programming
1707 language, one that is widely used among developers working in that
1710 The “System Libraries” of an executable work include anything,
1711 other than the work as a whole, that (a) is included in the normal
1712 form of packaging a Major Component, but which is not part of that
1713 Major Component, and (b) serves only to enable use of the work with
1714 that Major Component, or to implement a Standard Interface for
1715 which an implementation is available to the public in source code
1716 form. A “Major Component”, in this context, means a major
1717 essential component (kernel, window system, and so on) of the
1718 specific operating system (if any) on which the executable work
1719 runs, or a compiler used to produce the work, or an object code
1720 interpreter used to run it.
1722 The “Corresponding Source” for a work in object code form means all
1723 the source code needed to generate, install, and (for an executable
1724 work) run the object code and to modify the work, including scripts
1725 to control those activities. However, it does not include the
1726 work’s System Libraries, or general-purpose tools or generally
1727 available free programs which are used unmodified in performing
1728 those activities but which are not part of the work. For example,
1729 Corresponding Source includes interface definition files associated
1730 with source files for the work, and the source code for shared
1731 libraries and dynamically linked subprograms that the work is
1732 specifically designed to require, such as by intimate data
1733 communication or control flow between those subprograms and other
1736 The Corresponding Source need not include anything that users can
1737 regenerate automatically from other parts of the Corresponding
1740 The Corresponding Source for a work in source code form is that
1743 2. Basic Permissions.
1745 All rights granted under this License are granted for the term of
1746 copyright on the Program, and are irrevocable provided the stated
1747 conditions are met. This License explicitly affirms your unlimited
1748 permission to run the unmodified Program. The output from running
1749 a covered work is covered by this License only if the output, given
1750 its content, constitutes a covered work. This License acknowledges
1751 your rights of fair use or other equivalent, as provided by
1754 You may make, run and propagate covered works that you do not
1755 convey, without conditions so long as your license otherwise
1756 remains in force. You may convey covered works to others for the
1757 sole purpose of having them make modifications exclusively for you,
1758 or provide you with facilities for running those works, provided
1759 that you comply with the terms of this License in conveying all
1760 material for which you do not control copyright. Those thus making
1761 or running the covered works for you must do so exclusively on your
1762 behalf, under your direction and control, on terms that prohibit
1763 them from making any copies of your copyrighted material outside
1764 their relationship with you.
1766 Conveying under any other circumstances is permitted solely under
1767 the conditions stated below. Sublicensing is not allowed; section
1768 10 makes it unnecessary.
1770 3. Protecting Users’ Legal Rights From Anti-Circumvention Law.
1772 No covered work shall be deemed part of an effective technological
1773 measure under any applicable law fulfilling obligations under
1774 article 11 of the WIPO copyright treaty adopted on 20 December
1775 1996, or similar laws prohibiting or restricting circumvention of
1778 When you convey a covered work, you waive any legal power to forbid
1779 circumvention of technological measures to the extent such
1780 circumvention is effected by exercising rights under this License
1781 with respect to the covered work, and you disclaim any intention to
1782 limit operation or modification of the work as a means of
1783 enforcing, against the work’s users, your or third parties’ legal
1784 rights to forbid circumvention of technological measures.
1786 4. Conveying Verbatim Copies.
1788 You may convey verbatim copies of the Program’s source code as you
1789 receive it, in any medium, provided that you conspicuously and
1790 appropriately publish on each copy an appropriate copyright notice;
1791 keep intact all notices stating that this License and any
1792 non-permissive terms added in accord with section 7 apply to the
1793 code; keep intact all notices of the absence of any warranty; and
1794 give all recipients a copy of this License along with the Program.
1796 You may charge any price or no price for each copy that you convey,
1797 and you may offer support or warranty protection for a fee.
1799 5. Conveying Modified Source Versions.
1801 You may convey a work based on the Program, or the modifications to
1802 produce it from the Program, in the form of source code under the
1803 terms of section 4, provided that you also meet all of these
1806 a. The work must carry prominent notices stating that you
1807 modified it, and giving a relevant date.
1809 b. The work must carry prominent notices stating that it is
1810 released under this License and any conditions added under
1811 section 7. This requirement modifies the requirement in
1812 section 4 to “keep intact all notices”.
1814 c. You must license the entire work, as a whole, under this
1815 License to anyone who comes into possession of a copy. This
1816 License will therefore apply, along with any applicable
1817 section 7 additional terms, to the whole of the work, and all
1818 its parts, regardless of how they are packaged. This License
1819 gives no permission to license the work in any other way, but
1820 it does not invalidate such permission if you have separately
1823 d. If the work has interactive user interfaces, each must display
1824 Appropriate Legal Notices; however, if the Program has
1825 interactive interfaces that do not display Appropriate Legal
1826 Notices, your work need not make them do so.
1828 A compilation of a covered work with other separate and independent
1829 works, which are not by their nature extensions of the covered
1830 work, and which are not combined with it such as to form a larger
1831 program, in or on a volume of a storage or distribution medium, is
1832 called an “aggregate” if the compilation and its resulting
1833 copyright are not used to limit the access or legal rights of the
1834 compilation’s users beyond what the individual works permit.
1835 Inclusion of a covered work in an aggregate does not cause this
1836 License to apply to the other parts of the aggregate.
1838 6. Conveying Non-Source Forms.
1840 You may convey a covered work in object code form under the terms
1841 of sections 4 and 5, provided that you also convey the
1842 machine-readable Corresponding Source under the terms of this
1843 License, in one of these ways:
1845 a. Convey the object code in, or embodied in, a physical product
1846 (including a physical distribution medium), accompanied by the
1847 Corresponding Source fixed on a durable physical medium
1848 customarily used for software interchange.
1850 b. Convey the object code in, or embodied in, a physical product
1851 (including a physical distribution medium), accompanied by a
1852 written offer, valid for at least three years and valid for as
1853 long as you offer spare parts or customer support for that
1854 product model, to give anyone who possesses the object code
1855 either (1) a copy of the Corresponding Source for all the
1856 software in the product that is covered by this License, on a
1857 durable physical medium customarily used for software
1858 interchange, for a price no more than your reasonable cost of
1859 physically performing this conveying of source, or (2) access
1860 to copy the Corresponding Source from a network server at no
1863 c. Convey individual copies of the object code with a copy of the
1864 written offer to provide the Corresponding Source. This
1865 alternative is allowed only occasionally and noncommercially,
1866 and only if you received the object code with such an offer,
1867 in accord with subsection 6b.
1869 d. Convey the object code by offering access from a designated
1870 place (gratis or for a charge), and offer equivalent access to
1871 the Corresponding Source in the same way through the same
1872 place at no further charge. You need not require recipients
1873 to copy the Corresponding Source along with the object code.
1874 If the place to copy the object code is a network server, the
1875 Corresponding Source may be on a different server (operated by
1876 you or a third party) that supports equivalent copying
1877 facilities, provided you maintain clear directions next to the
1878 object code saying where to find the Corresponding Source.
1879 Regardless of what server hosts the Corresponding Source, you
1880 remain obligated to ensure that it is available for as long as
1881 needed to satisfy these requirements.
1883 e. Convey the object code using peer-to-peer transmission,
1884 provided you inform other peers where the object code and
1885 Corresponding Source of the work are being offered to the
1886 general public at no charge under subsection 6d.
1888 A separable portion of the object code, whose source code is
1889 excluded from the Corresponding Source as a System Library, need
1890 not be included in conveying the object code work.
1892 A “User Product” is either (1) a “consumer product”, which means
1893 any tangible personal property which is normally used for personal,
1894 family, or household purposes, or (2) anything designed or sold for
1895 incorporation into a dwelling. In determining whether a product is
1896 a consumer product, doubtful cases shall be resolved in favor of
1897 coverage. For a particular product received by a particular user,
1898 “normally used” refers to a typical or common use of that class of
1899 product, regardless of the status of the particular user or of the
1900 way in which the particular user actually uses, or expects or is
1901 expected to use, the product. A product is a consumer product
1902 regardless of whether the product has substantial commercial,
1903 industrial or non-consumer uses, unless such uses represent the
1904 only significant mode of use of the product.
1906 “Installation Information” for a User Product means any methods,
1907 procedures, authorization keys, or other information required to
1908 install and execute modified versions of a covered work in that
1909 User Product from a modified version of its Corresponding Source.
1910 The information must suffice to ensure that the continued
1911 functioning of the modified object code is in no case prevented or
1912 interfered with solely because modification has been made.
1914 If you convey an object code work under this section in, or with,
1915 or specifically for use in, a User Product, and the conveying
1916 occurs as part of a transaction in which the right of possession
1917 and use of the User Product is transferred to the recipient in
1918 perpetuity or for a fixed term (regardless of how the transaction
1919 is characterized), the Corresponding Source conveyed under this
1920 section must be accompanied by the Installation Information. But
1921 this requirement does not apply if neither you nor any third party
1922 retains the ability to install modified object code on the User
1923 Product (for example, the work has been installed in ROM).
1925 The requirement to provide Installation Information does not
1926 include a requirement to continue to provide support service,
1927 warranty, or updates for a work that has been modified or installed
1928 by the recipient, or for the User Product in which it has been
1929 modified or installed. Access to a network may be denied when the
1930 modification itself materially and adversely affects the operation
1931 of the network or violates the rules and protocols for
1932 communication across the network.
1934 Corresponding Source conveyed, and Installation Information
1935 provided, in accord with this section must be in a format that is
1936 publicly documented (and with an implementation available to the
1937 public in source code form), and must require no special password
1938 or key for unpacking, reading or copying.
1940 7. Additional Terms.
1942 “Additional permissions” are terms that supplement the terms of
1943 this License by making exceptions from one or more of its
1944 conditions. Additional permissions that are applicable to the
1945 entire Program shall be treated as though they were included in
1946 this License, to the extent that they are valid under applicable
1947 law. If additional permissions apply only to part of the Program,
1948 that part may be used separately under those permissions, but the
1949 entire Program remains governed by this License without regard to
1950 the additional permissions.
1952 When you convey a copy of a covered work, you may at your option
1953 remove any additional permissions from that copy, or from any part
1954 of it. (Additional permissions may be written to require their own
1955 removal in certain cases when you modify the work.) You may place
1956 additional permissions on material, added by you to a covered work,
1957 for which you have or can give appropriate copyright permission.
1959 Notwithstanding any other provision of this License, for material
1960 you add to a covered work, you may (if authorized by the copyright
1961 holders of that material) supplement the terms of this License with
1964 a. Disclaiming warranty or limiting liability differently from
1965 the terms of sections 15 and 16 of this License; or
1967 b. Requiring preservation of specified reasonable legal notices
1968 or author attributions in that material or in the Appropriate
1969 Legal Notices displayed by works containing it; or
1971 c. Prohibiting misrepresentation of the origin of that material,
1972 or requiring that modified versions of such material be marked
1973 in reasonable ways as different from the original version; or
1975 d. Limiting the use for publicity purposes of names of licensors
1976 or authors of the material; or
1978 e. Declining to grant rights under trademark law for use of some
1979 trade names, trademarks, or service marks; or
1981 f. Requiring indemnification of licensors and authors of that
1982 material by anyone who conveys the material (or modified
1983 versions of it) with contractual assumptions of liability to
1984 the recipient, for any liability that these contractual
1985 assumptions directly impose on those licensors and authors.
1987 All other non-permissive additional terms are considered “further
1988 restrictions” within the meaning of section 10. If the Program as
1989 you received it, or any part of it, contains a notice stating that
1990 it is governed by this License along with a term that is a further
1991 restriction, you may remove that term. If a license document
1992 contains a further restriction but permits relicensing or conveying
1993 under this License, you may add to a covered work material governed
1994 by the terms of that license document, provided that the further
1995 restriction does not survive such relicensing or conveying.
1997 If you add terms to a covered work in accord with this section, you
1998 must place, in the relevant source files, a statement of the
1999 additional terms that apply to those files, or a notice indicating
2000 where to find the applicable terms.
2002 Additional terms, permissive or non-permissive, may be stated in
2003 the form of a separately written license, or stated as exceptions;
2004 the above requirements apply either way.
2008 You may not propagate or modify a covered work except as expressly
2009 provided under this License. Any attempt otherwise to propagate or
2010 modify it is void, and will automatically terminate your rights
2011 under this License (including any patent licenses granted under the
2012 third paragraph of section 11).
2014 However, if you cease all violation of this License, then your
2015 license from a particular copyright holder is reinstated (a)
2016 provisionally, unless and until the copyright holder explicitly and
2017 finally terminates your license, and (b) permanently, if the
2018 copyright holder fails to notify you of the violation by some
2019 reasonable means prior to 60 days after the cessation.
2021 Moreover, your license from a particular copyright holder is
2022 reinstated permanently if the copyright holder notifies you of the
2023 violation by some reasonable means, this is the first time you have
2024 received notice of violation of this License (for any work) from
2025 that copyright holder, and you cure the violation prior to 30 days
2026 after your receipt of the notice.
2028 Termination of your rights under this section does not terminate
2029 the licenses of parties who have received copies or rights from you
2030 under this License. If your rights have been terminated and not
2031 permanently reinstated, you do not qualify to receive new licenses
2032 for the same material under section 10.
2034 9. Acceptance Not Required for Having Copies.
2036 You are not required to accept this License in order to receive or
2037 run a copy of the Program. Ancillary propagation of a covered work
2038 occurring solely as a consequence of using peer-to-peer
2039 transmission to receive a copy likewise does not require
2040 acceptance. However, nothing other than this License grants you
2041 permission to propagate or modify any covered work. These actions
2042 infringe copyright if you do not accept this License. Therefore,
2043 by modifying or propagating a covered work, you indicate your
2044 acceptance of this License to do so.
2046 10. Automatic Licensing of Downstream Recipients.
2048 Each time you convey a covered work, the recipient automatically
2049 receives a license from the original licensors, to run, modify and
2050 propagate that work, subject to this License. You are not
2051 responsible for enforcing compliance by third parties with this
2054 An “entity transaction” is a transaction transferring control of an
2055 organization, or substantially all assets of one, or subdividing an
2056 organization, or merging organizations. If propagation of a
2057 covered work results from an entity transaction, each party to that
2058 transaction who receives a copy of the work also receives whatever
2059 licenses to the work the party’s predecessor in interest had or
2060 could give under the previous paragraph, plus a right to possession
2061 of the Corresponding Source of the work from the predecessor in
2062 interest, if the predecessor has it or can get it with reasonable
2065 You may not impose any further restrictions on the exercise of the
2066 rights granted or affirmed under this License. For example, you
2067 may not impose a license fee, royalty, or other charge for exercise
2068 of rights granted under this License, and you may not initiate
2069 litigation (including a cross-claim or counterclaim in a lawsuit)
2070 alleging that any patent claim is infringed by making, using,
2071 selling, offering for sale, or importing the Program or any portion
2076 A “contributor” is a copyright holder who authorizes use under this
2077 License of the Program or a work on which the Program is based.
2078 The work thus licensed is called the contributor’s “contributor
2081 A contributor’s “essential patent claims” are all patent claims
2082 owned or controlled by the contributor, whether already acquired or
2083 hereafter acquired, that would be infringed by some manner,
2084 permitted by this License, of making, using, or selling its
2085 contributor version, but do not include claims that would be
2086 infringed only as a consequence of further modification of the
2087 contributor version. For purposes of this definition, “control”
2088 includes the right to grant patent sublicenses in a manner
2089 consistent with the requirements of this License.
2091 Each contributor grants you a non-exclusive, worldwide,
2092 royalty-free patent license under the contributor’s essential
2093 patent claims, to make, use, sell, offer for sale, import and
2094 otherwise run, modify and propagate the contents of its contributor
2097 In the following three paragraphs, a “patent license” is any
2098 express agreement or commitment, however denominated, not to
2099 enforce a patent (such as an express permission to practice a
2100 patent or covenant not to sue for patent infringement). To “grant”
2101 such a patent license to a party means to make such an agreement or
2102 commitment not to enforce a patent against the party.
2104 If you convey a covered work, knowingly relying on a patent
2105 license, and the Corresponding Source of the work is not available
2106 for anyone to copy, free of charge and under the terms of this
2107 License, through a publicly available network server or other
2108 readily accessible means, then you must either (1) cause the
2109 Corresponding Source to be so available, or (2) arrange to deprive
2110 yourself of the benefit of the patent license for this particular
2111 work, or (3) arrange, in a manner consistent with the requirements
2112 of this License, to extend the patent license to downstream
2113 recipients. “Knowingly relying” means you have actual knowledge
2114 that, but for the patent license, your conveying the covered work
2115 in a country, or your recipient’s use of the covered work in a
2116 country, would infringe one or more identifiable patents in that
2117 country that you have reason to believe are valid.
2119 If, pursuant to or in connection with a single transaction or
2120 arrangement, you convey, or propagate by procuring conveyance of, a
2121 covered work, and grant a patent license to some of the parties
2122 receiving the covered work authorizing them to use, propagate,
2123 modify or convey a specific copy of the covered work, then the
2124 patent license you grant is automatically extended to all
2125 recipients of the covered work and works based on it.
2127 A patent license is “discriminatory” if it does not include within
2128 the scope of its coverage, prohibits the exercise of, or is
2129 conditioned on the non-exercise of one or more of the rights that
2130 are specifically granted under this License. You may not convey a
2131 covered work if you are a party to an arrangement with a third
2132 party that is in the business of distributing software, under which
2133 you make payment to the third party based on the extent of your
2134 activity of conveying the work, and under which the third party
2135 grants, to any of the parties who would receive the covered work
2136 from you, a discriminatory patent license (a) in connection with
2137 copies of the covered work conveyed by you (or copies made from
2138 those copies), or (b) primarily for and in connection with specific
2139 products or compilations that contain the covered work, unless you
2140 entered into that arrangement, or that patent license was granted,
2141 prior to 28 March 2007.
2143 Nothing in this License shall be construed as excluding or limiting
2144 any implied license or other defenses to infringement that may
2145 otherwise be available to you under applicable patent law.
2147 12. No Surrender of Others’ Freedom.
2149 If conditions are imposed on you (whether by court order, agreement
2150 or otherwise) that contradict the conditions of this License, they
2151 do not excuse you from the conditions of this License. If you
2152 cannot convey a covered work so as to satisfy simultaneously your
2153 obligations under this License and any other pertinent obligations,
2154 then as a consequence you may not convey it at all. For example,
2155 if you agree to terms that obligate you to collect a royalty for
2156 further conveying from those to whom you convey the Program, the
2157 only way you could satisfy both those terms and this License would
2158 be to refrain entirely from conveying the Program.
2160 13. Use with the GNU Affero General Public License.
2162 Notwithstanding any other provision of this License, you have
2163 permission to link or combine any covered work with a work licensed
2164 under version 3 of the GNU Affero General Public License into a
2165 single combined work, and to convey the resulting work. The terms
2166 of this License will continue to apply to the part which is the
2167 covered work, but the special requirements of the GNU Affero
2168 General Public License, section 13, concerning interaction through
2169 a network will apply to the combination as such.
2171 14. Revised Versions of this License.
2173 The Free Software Foundation may publish revised and/or new
2174 versions of the GNU General Public License from time to time. Such
2175 new versions will be similar in spirit to the present version, but
2176 may differ in detail to address new problems or concerns.
2178 Each version is given a distinguishing version number. If the
2179 Program specifies that a certain numbered version of the GNU
2180 General Public License “or any later version” applies to it, you
2181 have the option of following the terms and conditions either of
2182 that numbered version or of any later version published by the Free
2183 Software Foundation. If the Program does not specify a version
2184 number of the GNU General Public License, you may choose any
2185 version ever published by the Free Software Foundation.
2187 If the Program specifies that a proxy can decide which future
2188 versions of the GNU General Public License can be used, that
2189 proxy’s public statement of acceptance of a version permanently
2190 authorizes you to choose that version for the Program.
2192 Later license versions may give you additional or different
2193 permissions. However, no additional obligations are imposed on any
2194 author or copyright holder as a result of your choosing to follow a
2197 15. Disclaimer of Warranty.
2199 THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
2200 APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE
2201 COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM “AS IS”
2202 WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED,
2203 INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
2204 MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE
2205 RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU.
2206 SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL
2207 NECESSARY SERVICING, REPAIR OR CORRECTION.
2209 16. Limitation of Liability.
2211 IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN
2212 WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES
2213 AND/OR CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR
2214 DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR
2215 CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE
2216 THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA
2217 BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
2218 PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
2219 PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF
2220 THE POSSIBILITY OF SUCH DAMAGES.
2222 17. Interpretation of Sections 15 and 16.
2224 If the disclaimer of warranty and limitation of liability provided
2225 above cannot be given local legal effect according to their terms,
2226 reviewing courts shall apply local law that most closely
2227 approximates an absolute waiver of all civil liability in
2228 connection with the Program, unless a warranty or assumption of
2229 liability accompanies a copy of the Program in return for a fee.
2231 END OF TERMS AND CONDITIONS
2233 How to Apply These Terms to Your New Programs
2234 =============================================
2236 If you develop a new program, and you want it to be of the greatest
2237 possible use to the public, the best way to achieve this is to make it
2238 free software which everyone can redistribute and change under these
2241 To do so, attach the following notices to the program. It is safest
2242 to attach them to the start of each source file to most effectively
2243 state the exclusion of warranty; and each file should have at least the
2244 “copyright” line and a pointer to where the full notice is found.
2246 ONE LINE TO GIVE THE PROGRAM'S NAME AND A BRIEF IDEA OF WHAT IT DOES.
2247 Copyright (C) YEAR NAME OF AUTHOR
2249 This program is free software: you can redistribute it and/or modify
2250 it under the terms of the GNU General Public License as published by
2251 the Free Software Foundation, either version 3 of the License, or (at
2252 your option) any later version.
2254 This program is distributed in the hope that it will be useful, but
2255 WITHOUT ANY WARRANTY; without even the implied warranty of
2256 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
2257 General Public License for more details.
2259 You should have received a copy of the GNU General Public License
2260 along with this program. If not, see <https://www.gnu.org/licenses/>.
2262 Also add information on how to contact you by electronic and paper mail.
2264 If the program does terminal interaction, make it output a short notice
2265 like this when it starts in an interactive mode:
2267 PROGRAM Copyright (C) YEAR NAME OF AUTHOR
2268 This program comes with ABSOLUTELY NO WARRANTY; for details
2269 type ‘show w’. This is free software, and you are
2270 welcome to redistribute it under certain conditions;
2271 type ‘show c’ for details.
2273 The hypothetical commands ‘show w’ and ‘show c’ should show the
2274 appropriate parts of the General Public License. Of course, your
2275 program’s commands might be different; for a GUI interface, you would
2278 You should also get your employer (if you work as a programmer) or
2279 school, if any, to sign a “copyright disclaimer” for the program, if
2280 necessary. For more information on this, and how to apply and follow
2281 the GNU GPL, see <https://www.gnu.org/licenses/>.
2283 The GNU General Public License does not permit incorporating your
2284 program into proprietary programs. If your program is a subroutine
2285 library, you may consider it more useful to permit linking proprietary
2286 applications with the library. If this is what you want to do, use the
2287 GNU Lesser General Public License instead of this License. But first,
2288 please read <https://www.gnu.org/philosophy/why-not-lgpl.html>.
2291 File: gpgme.info, Node: Concept Index, Next: Function and Data Index, Prev: Copying, Up: Top
2299 * aborting operations: Cancellation. (line 6)
2300 * algorithms: Algorithms. (line 6)
2301 * algorithms, hash: Hash Algorithms. (line 6)
2302 * algorithms, message digest: Hash Algorithms. (line 6)
2303 * algorithms, public key: Public Key Algorithms. (line 6)
2304 * armor mode: ASCII Armor. (line 6)
2305 * ASCII armor: ASCII Armor. (line 6)
2306 * ASSUAN: Assuan. (line 6)
2307 * attributes, of a key: Information About Keys.
2309 * auditlog: Additional Logs. (line 6)
2310 * auditlog, of the engine: Additional Logs. (line 6)
2311 * autoconf: Using Automake. (line 6)
2312 * automake: Using Automake. (line 6)
2313 * backend: Protocols and Engines. (line 6)
2314 * callback, passphrase: Passphrase Callback. (line 6)
2315 * callback, progress meter: Progress Meter Callback.
2317 * callback, status message: Status Message Callback.
2319 * cancelling operations: Cancellation. (line 6)
2320 * canonical text mode: Text Mode. (line 6)
2321 * certificates, included: Included Certificates. (line 6)
2322 * CMS: Cryptographic Message Syntax.
2324 * compiler flags: Building the Source. (line 6)
2325 * compiler options: Building the Source. (line 6)
2326 * configuration of crypto backend: Engine Configuration. (line 6)
2327 * context: Contexts. (line 6)
2328 * context, armor mode: ASCII Armor. (line 6)
2329 * context, attributes: Context Attributes. (line 6)
2330 * context, configuring engine: Crypto Engine. (line 6)
2331 * context, creation: Creating Contexts. (line 6)
2332 * context, destruction: Destroying Contexts. (line 6)
2333 * context, offline mode: Offline Mode. (line 6)
2334 * context, pinentry mode: Pinentry Mode. (line 6)
2335 * context, result of operation: Result Management. (line 6)
2336 * context, selecting protocol: Protocol Selection. (line 6)
2337 * context, sender: Setting the Sender. (line 6)
2338 * context, text mode: Text Mode. (line 6)
2339 * crypto backend: Protocols and Engines. (line 6)
2340 * crypto engine: Protocols and Engines. (line 6)
2341 * cryptographic message syntax: Cryptographic Message Syntax.
2343 * cryptographic operation: Crypto Operations. (line 6)
2344 * cryptographic operation, aborting: Cancellation. (line 6)
2345 * cryptographic operation, cancelling: Cancellation. (line 6)
2346 * cryptographic operation, decryption: Decrypt. (line 6)
2347 * cryptographic operation, decryption and verification: Decrypt and Verify.
2349 * cryptographic operation, encryption: Encrypt. (line 6)
2350 * cryptographic operation, running: Run Control. (line 6)
2351 * cryptographic operation, signature check: Verify. (line 6)
2352 * cryptographic operation, signing: Sign. (line 6)
2353 * cryptographic operation, verification: Verify. (line 6)
2354 * cryptographic operation, wait for: Waiting For Completion.
2356 * data buffer, convenience: Data Buffer Convenience.
2358 * data buffer, creation: Creating Data Buffers. (line 6)
2359 * data buffer, destruction: Destroying Data Buffers.
2361 * data buffer, encoding: Data Buffer Meta-Data. (line 6)
2362 * data buffer, file name: Data Buffer Meta-Data. (line 6)
2363 * data buffer, I/O operations: Data Buffer I/O Operations.
2365 * data buffer, manipulation: Manipulating Data Buffers.
2367 * data buffer, meta-data: Data Buffer Meta-Data. (line 6)
2368 * data buffer, read: Data Buffer I/O Operations.
2370 * data buffer, seek: Data Buffer I/O Operations.
2372 * data buffer, write: Data Buffer I/O Operations.
2374 * data, exchanging: Exchanging Data. (line 6)
2375 * debug: Debugging. (line 6)
2376 * decryption: Decrypt. (line 6)
2377 * decryption and verification: Decrypt and Verify. (line 6)
2378 * deprecated: Deprecated Functions. (line 6)
2379 * encryption: Encrypt. (line 6)
2380 * engine: Protocols and Engines. (line 6)
2381 * engine, ASSUAN: Assuan. (line 6)
2382 * engine, configuration of: Engine Configuration. (line 6)
2383 * engine, configuration per context: Crypto Engine. (line 6)
2384 * engine, GnuPG: OpenPGP. (line 6)
2385 * engine, GpgSM: Cryptographic Message Syntax.
2387 * engine, information about: Engine Information. (line 6)
2388 * error codes: Error Values. (line 6)
2389 * error codes, list of: Error Sources. (line 6)
2390 * error codes, list of <1>: Error Codes. (line 6)
2391 * error codes, printing of: Error Strings. (line 6)
2392 * error handling: Error Handling. (line 6)
2393 * error sources: Error Values. (line 6)
2394 * error sources, printing of: Error Strings. (line 6)
2395 * error strings: Error Strings. (line 6)
2396 * error values: Error Values. (line 6)
2397 * error values, printing of: Error Strings. (line 6)
2398 * event loop, external: Using External Event Loops.
2400 * flags, of a context: Context Flags. (line 6)
2401 * From:: Setting the Sender. (line 6)
2402 * GDK, using GPGME with: I/O Callback Example GDK.
2404 * GnuPG: OpenPGP. (line 6)
2405 * GPGME_DEBUG: Debugging. (line 6)
2406 * GpgSM: Cryptographic Message Syntax.
2408 * GTK+, using GPGME with: I/O Callback Example GTK+.
2410 * hash algorithms: Hash Algorithms. (line 6)
2411 * header file: Header. (line 6)
2412 * identify: Data Buffer Convenience.
2414 * include file: Header. (line 6)
2415 * key listing: Listing Keys. (line 6)
2416 * key listing mode: Key Listing Mode. (line 6)
2417 * key listing, mode of: Key Listing Mode. (line 6)
2418 * key listing, start: Listing Keys. (line 6)
2419 * key management: Key Management. (line 6)
2420 * key ring, add: Generating Keys. (line 6)
2421 * key ring, delete from: Deleting Keys. (line 6)
2422 * key ring, export from: Exporting Keys. (line 6)
2423 * key ring, import to: Importing Keys. (line 6)
2424 * key ring, list: Listing Keys. (line 6)
2425 * key ring, search: Listing Keys. (line 6)
2426 * key, attributes: Information About Keys.
2428 * key, creation: Generating Keys. (line 6)
2429 * key, delete: Deleting Keys. (line 6)
2430 * key, edit: Advanced Key Editing. (line 6)
2431 * key, export: Exporting Keys. (line 6)
2432 * key, import: Importing Keys. (line 6)
2433 * key, information about: Information About Keys.
2435 * key, manipulation: Manipulating Keys. (line 6)
2436 * key, signing: Signing Keys. (line 6)
2437 * largefile support: Largefile Support (LFS).
2439 * LFS: Largefile Support (LFS).
2441 * LGPL, GNU Lesser General Public License: Library Copying. (line 6)
2442 * libtool: Using Libtool. (line 6)
2443 * listing keys: Listing Keys. (line 6)
2444 * locale, default: Locale. (line 6)
2445 * locale, of a context: Locale. (line 6)
2446 * message digest algorithms: Hash Algorithms. (line 6)
2447 * multi-threading: Multi-Threading. (line 6)
2448 * notation data: Verify. (line 6)
2449 * notation data <1>: Signature Notation Data.
2451 * offline mode: Offline Mode. (line 6)
2452 * OpenPGP: OpenPGP. (line 6)
2453 * passphrase callback: Passphrase Callback. (line 6)
2454 * passphrase, change: Changing Passphrases. (line 6)
2455 * pinentry mode: Pinentry Mode. (line 6)
2456 * policy URL: Signature Notation Data.
2458 * progress meter callback: Progress Meter Callback.
2460 * protocol: Protocols and Engines. (line 6)
2461 * protocol, ASSUAN: Assuan. (line 6)
2462 * protocol, CMS: Cryptographic Message Syntax.
2464 * protocol, GnuPG: OpenPGP. (line 6)
2465 * protocol, S/MIME: Cryptographic Message Syntax.
2467 * protocol, selecting: Protocol Selection. (line 6)
2468 * public key algorithms: Public Key Algorithms. (line 6)
2469 * Qt, using GPGME with: I/O Callback Example Qt.
2471 * run control: Run Control. (line 6)
2472 * S/MIME: Cryptographic Message Syntax.
2474 * sender: Setting the Sender. (line 6)
2475 * sign: Sign. (line 6)
2476 * signal handling: Signal Handling. (line 6)
2477 * signals: Signal Handling. (line 6)
2478 * signature check: Decrypt and Verify. (line 6)
2479 * signature notation data: Verify. (line 6)
2480 * signature notation data <1>: Signature Notation Data.
2482 * signature, creation: Sign. (line 6)
2483 * signature, selecting signers: Selecting Signers. (line 6)
2484 * signature, verification: Verify. (line 6)
2485 * signers, selecting: Selecting Signers. (line 6)
2486 * status message callback: Status Message Callback.
2488 * text mode: Text Mode. (line 6)
2489 * thread-safeness: Multi-Threading. (line 6)
2490 * trust item: Trust Item Management. (line 6)
2491 * trust item list: Listing Trust Items. (line 6)
2492 * trust item, manipulation: Manipulating Trust Items.
2494 * type of data: Data Buffer Convenience.
2496 * UI server: UI Server Protocol. (line 6)
2497 * user interface server: UI Server Protocol. (line 6)
2498 * validity, TOFU: Changing TOFU Data. (line 6)
2499 * verification: Verify. (line 6)
2500 * verification and decryption: Decrypt and Verify. (line 6)
2501 * version check, of the engines: Engine Version Check. (line 6)
2502 * version check, of the library: Library Version Check. (line 6)
2503 * wait for completion: Waiting For Completion.
2507 File: gpgme.info, Node: Function and Data Index, Prev: Concept Index, Up: Top
2509 Function and Data Index
2510 ***********************
2515 * AM_PATH_GPGME: Using Automake. (line 11)
2516 * AM_PATH_GPGME_PTH: Using Automake. (line 13)
2517 * AM_PATH_GPGME_PTHREAD: Using Automake. (line 15)
2518 * CHECKSUM_CREATE_FILES: UI Server Checksum Files.
2520 * CHECKSUM_VERIFY_FILES: UI Server Checksum Files.
2522 * DECRYPT: UI Server Decrypt. (line 26)
2523 * DECRYPT_FILES: UI Server Verify/Decrypt Files.
2525 * DECRYPT_VERIFY_FILES: UI Server Verify/Decrypt Files.
2527 * ENCRYPT: UI Server Encrypt. (line 47)
2528 * ENCRYPT_FILES: UI Server Sign/Encrypt Files.
2530 * ENCRYPT_SIGN_FILES: UI Server Sign/Encrypt Files.
2532 * enum gpgme_data_encoding_t: Data Buffer Meta-Data.
2534 * enum gpgme_data_type_t: Data Buffer Convenience.
2536 * enum gpgme_event_io_t: I/O Callback Interface.
2538 * enum gpgme_hash_algo_t: Hash Algorithms. (line 9)
2539 * enum gpgme_pinentry_mode_t: Pinentry Mode. (line 25)
2540 * enum gpgme_protocol_t: Protocols and Engines.
2542 * enum gpgme_pubkey_algo_t: Public Key Algorithms.
2544 * enum gpgme_sig_mode_t: Creating a Signature.
2546 * enum gpgme_sig_stat_t: Deprecated Functions.
2548 * enum gpgme_tofu_policy_t: Changing TOFU Data. (line 10)
2549 * FILE: UI Server Set Input Files.
2551 * GETINFO: Miscellaneous UI Server Commands.
2553 * gpgme_addrspec_from_uid: Decrypt and Verify. (line 48)
2554 * gpgme_attr_t: Deprecated Functions.
2556 * gpgme_attr_t <1>: Deprecated Functions.
2558 * gpgme_cancel: Cancellation. (line 16)
2559 * gpgme_cancel_async: Cancellation. (line 38)
2560 * gpgme_check_version: Library Version Check.
2562 * gpgme_ctx_get_engine_info: Crypto Engine. (line 12)
2563 * gpgme_ctx_set_engine_info: Crypto Engine. (line 26)
2564 * gpgme_ctx_t: Contexts. (line 11)
2565 * gpgme_data_encoding_t: Data Buffer Meta-Data.
2567 * gpgme_data_get_encoding: Data Buffer Meta-Data.
2569 * gpgme_data_get_file_name: Data Buffer Meta-Data.
2571 * gpgme_data_identify: Data Buffer Convenience.
2573 * gpgme_data_new: Memory Based Data Buffers.
2575 * gpgme_data_new_from_cbs: Callback Based Data Buffers.
2577 * gpgme_data_new_from_estream: File Based Data Buffers.
2579 * gpgme_data_new_from_fd: File Based Data Buffers.
2581 * gpgme_data_new_from_file: Memory Based Data Buffers.
2583 * gpgme_data_new_from_filepart: Memory Based Data Buffers.
2585 * gpgme_data_new_from_mem: Memory Based Data Buffers.
2587 * gpgme_data_new_from_stream: File Based Data Buffers.
2589 * gpgme_data_new_with_read_cb: Deprecated Functions.
2591 * gpgme_data_read: Data Buffer I/O Operations.
2593 * gpgme_data_read_cb_t: Callback Based Data Buffers.
2595 * gpgme_data_release: Destroying Data Buffers.
2597 * gpgme_data_release_and_get_mem: Destroying Data Buffers.
2599 * gpgme_data_release_cb_t: Callback Based Data Buffers.
2601 * gpgme_data_rewind: Deprecated Functions.
2603 * gpgme_data_seek: Data Buffer I/O Operations.
2605 * gpgme_data_seek_cb_t: Callback Based Data Buffers.
2607 * gpgme_data_set_encoding: Data Buffer Meta-Data.
2609 * gpgme_data_set_file_name: Data Buffer Meta-Data.
2611 * gpgme_data_set_flag: Data Buffer Meta-Data.
2613 * gpgme_data_t: Exchanging Data. (line 13)
2614 * gpgme_data_type_t: Data Buffer Convenience.
2616 * gpgme_data_write: Data Buffer I/O Operations.
2618 * gpgme_data_write_cb_t: Callback Based Data Buffers.
2620 * gpgme_decrypt_result_t: Decrypt. (line 101)
2621 * gpgme_edit_cb_t: Deprecated Functions.
2623 * gpgme_encrypt_result_t: Encrypting a Plaintext.
2625 * gpgme_engine_check_version: Engine Version Check.
2627 * gpgme_engine_info_t: Engine Information. (line 6)
2628 * gpgme_error: Error Values. (line 65)
2629 * gpgme_error_from_errno: Error Values. (line 89)
2630 * gpgme_error_t: Error Values. (line 24)
2631 * gpgme_error_t (*gpgme_assuan_data_cb_t) (void *OPAQUE, const void *DATA, size_t DATALEN): Using the Assuan protocol.
2633 * gpgme_error_t (*gpgme_assuan_inquire_cb_t) (void *OPAQUE, const char *NAME, const char *ARGS, gpgme_data_t *R_DATA): Using the Assuan protocol.
2635 * gpgme_error_t (*gpgme_assuan_status_cb_t) (void *OPAQUE, const char *STATUS, const char *ARGS): Using the Assuan protocol.
2637 * gpgme_error_t (*gpgme_edit_cb_t) (void *HANDLE, gpgme_status_code_t STATUS, const char *ARGS, int FD): Deprecated Functions.
2639 * gpgme_error_t (*gpgme_interact_cb_t) (void *HANDLE, const char *STATUS, const char *ARGS, int FD): Advanced Key Editing.
2641 * gpgme_error_t (*gpgme_io_cb_t) (void *DATA, int FD): I/O Callback Interface.
2643 * gpgme_error_t (*gpgme_passphrase_cb_t)(void *HOOK, const char *UID_HINT, const char *PASSPHRASE_INFO, int PREV_WAS_BAD, int FD): Passphrase Callback.
2645 * gpgme_error_t (*gpgme_register_io_cb_t) (void *DATA, int FD, int DIR, gpgme_io_cb_t FNC, void *FNC_DATA, void **TAG): I/O Callback Interface.
2647 * gpgme_error_t (*gpgme_status_cb_t)(void *HOOK, const char *KEYWORD, const char *ARGS): Status Message Callback.
2649 * gpgme_err_code: Error Values. (line 42)
2650 * gpgme_err_code_from_errno: Error Values. (line 98)
2651 * gpgme_err_code_t: Error Values. (line 6)
2652 * gpgme_err_code_to_errno: Error Values. (line 103)
2653 * gpgme_err_make: Error Values. (line 57)
2654 * gpgme_err_make_from_errno: Error Values. (line 83)
2655 * gpgme_err_source: Error Values. (line 49)
2656 * gpgme_err_source_t: Error Values. (line 13)
2657 * gpgme_event_io_t: I/O Callback Interface.
2659 * gpgme_event_io_t <1>: Registering I/O Callbacks.
2661 * gpgme_free: Destroying Data Buffers.
2663 * gpgme_genkey_result_t: Generating Keys. (line 381)
2664 * gpgme_get_armor: ASCII Armor. (line 13)
2665 * gpgme_get_ctx_flag: Context Flags. (line 121)
2666 * gpgme_get_dirinfo: Engine Version Check.
2668 * gpgme_get_engine_info: Engine Information. (line 46)
2669 * gpgme_get_include_certs: Included Certificates.
2671 * gpgme_get_io_cbs: Registering I/O Callbacks.
2673 * gpgme_get_key: Listing Keys. (line 178)
2674 * gpgme_get_keylist_mode: Key Listing Mode. (line 95)
2675 * gpgme_get_offline: Offline Mode. (line 31)
2676 * gpgme_get_passphrase_cb: Passphrase Callback. (line 63)
2677 * gpgme_get_pinentry_mode: Pinentry Mode. (line 18)
2678 * gpgme_get_progress_cb: Progress Meter Callback.
2680 * gpgme_get_protocol: Protocol Selection. (line 21)
2681 * gpgme_get_protocol_name: Protocols and Engines.
2683 * gpgme_get_sender: Setting the Sender. (line 29)
2684 * gpgme_get_sig_key: Deprecated Functions.
2686 * gpgme_get_sig_status: Deprecated Functions.
2688 * gpgme_get_sig_string_attr: Deprecated Functions.
2690 * gpgme_get_sig_ulong_attr: Deprecated Functions.
2692 * gpgme_get_status_cb: Status Message Callback.
2694 * gpgme_get_textmode: Text Mode. (line 20)
2695 * gpgme_hash_algo_name: Hash Algorithms. (line 30)
2696 * gpgme_hash_algo_t: Hash Algorithms. (line 10)
2697 * gpgme_import_result_t: Importing Keys. (line 118)
2698 * gpgme_import_status_t: Importing Keys. (line 80)
2699 * gpgme_interact_cb_t: Advanced Key Editing.
2701 * gpgme_invalid_key_t: Crypto Operations. (line 10)
2702 * gpgme_io_cb_t: I/O Callback Interface.
2704 * gpgme_keylist_result_t: Listing Keys. (line 155)
2705 * gpgme_key_get_string_attr: Deprecated Functions.
2707 * gpgme_key_get_ulong_attr: Deprecated Functions.
2709 * gpgme_key_ref: Manipulating Keys. (line 6)
2710 * gpgme_key_release: Deprecated Functions.
2712 * gpgme_key_sig_get_string_attr: Deprecated Functions.
2714 * gpgme_key_sig_get_ulong_attr: Deprecated Functions.
2716 * gpgme_key_sig_t: Key objects. (line 339)
2717 * gpgme_key_t: Key objects. (line 10)
2718 * gpgme_key_unref: Manipulating Keys. (line 10)
2719 * gpgme_new: Creating Contexts. (line 6)
2720 * gpgme_new_signature_t: Creating a Signature.
2722 * gpgme_off_t: Exchanging Data. (line 24)
2723 * gpgme_op_adduid: Generating Keys. (line 189)
2724 * gpgme_op_adduid_start: Generating Keys. (line 215)
2725 * gpgme_op_assuan_transact_ext: Using the Assuan protocol.
2727 * gpgme_op_assuan_transact_start: Using the Assuan protocol.
2729 * gpgme_op_card_edit: Deprecated Functions.
2731 * gpgme_op_card_edit_start: Deprecated Functions.
2733 * gpgme_op_createkey: Generating Keys. (line 14)
2734 * gpgme_op_createkey_start: Generating Keys. (line 119)
2735 * gpgme_op_createsubkey: Generating Keys. (line 132)
2736 * gpgme_op_createsubkey_start: Generating Keys. (line 176)
2737 * gpgme_op_decrypt: Decrypt. (line 6)
2738 * gpgme_op_decrypt_ext: Decrypt. (line 30)
2739 * gpgme_op_decrypt_ext_start: Decrypt. (line 60)
2740 * gpgme_op_decrypt_result: Decrypt. (line 164)
2741 * gpgme_op_decrypt_start: Decrypt. (line 20)
2742 * gpgme_op_decrypt_verify: Decrypt and Verify. (line 6)
2743 * gpgme_op_decrypt_verify_start: Decrypt and Verify. (line 30)
2744 * gpgme_op_delete: Deleting Keys. (line 47)
2745 * gpgme_op_delete_ext: Deleting Keys. (line 6)
2746 * gpgme_op_delete_ext_start: Deleting Keys. (line 33)
2747 * gpgme_op_delete_start: Deleting Keys. (line 52)
2748 * gpgme_op_edit: Deprecated Functions.
2750 * gpgme_op_edit_start: Deprecated Functions.
2752 * gpgme_op_encrypt: Encrypting a Plaintext.
2754 * gpgme_op_encrypt_ext: Encrypting a Plaintext.
2756 * gpgme_op_encrypt_ext_start: Encrypting a Plaintext.
2758 * gpgme_op_encrypt_result: Encrypting a Plaintext.
2760 * gpgme_op_encrypt_sign: Encrypting a Plaintext.
2762 * gpgme_op_encrypt_sign_ext: Encrypting a Plaintext.
2764 * gpgme_op_encrypt_sign_ext_start: Encrypting a Plaintext.
2766 * gpgme_op_encrypt_sign_start: Encrypting a Plaintext.
2768 * gpgme_op_encrypt_start: Encrypting a Plaintext.
2770 * gpgme_op_export: Exporting Keys. (line 50)
2771 * gpgme_op_export_ext: Exporting Keys. (line 83)
2772 * gpgme_op_export_ext_start: Exporting Keys. (line 105)
2773 * gpgme_op_export_keys: Exporting Keys. (line 117)
2774 * gpgme_op_export_keys_start: Exporting Keys. (line 144)
2775 * gpgme_op_export_start: Exporting Keys. (line 71)
2776 * gpgme_op_genkey: Generating Keys. (line 304)
2777 * gpgme_op_genkey_result: Generating Keys. (line 418)
2778 * gpgme_op_genkey_start: Generating Keys. (line 369)
2779 * gpgme_op_getauditlog: Additional Logs. (line 9)
2780 * gpgme_op_getauditlog_start: Additional Logs. (line 54)
2781 * gpgme_op_import: Importing Keys. (line 9)
2782 * gpgme_op_import_ext: Deprecated Functions.
2784 * gpgme_op_import_keys: Importing Keys. (line 35)
2785 * gpgme_op_import_keys_start: Importing Keys. (line 65)
2786 * gpgme_op_import_result: Importing Keys. (line 174)
2787 * gpgme_op_import_start: Importing Keys. (line 24)
2788 * gpgme_op_interact: Advanced Key Editing.
2790 * gpgme_op_interact_start: Advanced Key Editing.
2792 * gpgme_op_keylist_end: Listing Keys. (line 111)
2793 * gpgme_op_keylist_ext_start: Listing Keys. (line 34)
2794 * gpgme_op_keylist_from_data_start: Listing Keys. (line 67)
2795 * gpgme_op_keylist_next: Listing Keys. (line 94)
2796 * gpgme_op_keylist_result: Listing Keys. (line 166)
2797 * gpgme_op_keylist_start: Listing Keys. (line 6)
2798 * gpgme_op_keysign: Signing Keys. (line 12)
2799 * gpgme_op_keysign_start: Signing Keys. (line 73)
2800 * gpgme_op_passwd: Changing Passphrases.
2802 * gpgme_op_passwd_start: Changing Passphrases.
2804 * gpgme_op_query_swdb: Checking for updates.
2806 * gpgme_op_query_swdb_result: Checking for updates.
2808 * gpgme_op_revuid: Generating Keys. (line 224)
2809 * gpgme_op_revuid_start: Generating Keys. (line 252)
2810 * gpgme_op_set_uid_flag_start: Generating Keys. (line 293)
2811 * gpgme_op_set_ui_flag: Generating Keys. (line 261)
2812 * gpgme_op_sign: Creating a Signature.
2814 * gpgme_op_sign_result: Creating a Signature.
2816 * gpgme_op_sign_start: Creating a Signature.
2818 * gpgme_op_spawn: Running other Programs.
2820 * gpgme_op_spawn_start: Running other Programs.
2822 * gpgme_op_tofu_policy: Changing TOFU Data. (line 29)
2823 * gpgme_op_tofu_policy_start: Changing TOFU Data. (line 43)
2824 * gpgme_op_trustlist_end: Listing Trust Items. (line 44)
2825 * gpgme_op_trustlist_next: Listing Trust Items. (line 27)
2826 * gpgme_op_trustlist_start: Listing Trust Items. (line 6)
2827 * gpgme_op_verify: Verify. (line 6)
2828 * gpgme_op_verify_result: Verify. (line 290)
2829 * gpgme_op_verify_start: Verify. (line 26)
2830 * gpgme_passphrase_cb_t: Passphrase Callback. (line 10)
2831 * gpgme_pinentry_mode_t: Pinentry Mode. (line 26)
2832 * gpgme_progress_cb_t: Progress Meter Callback.
2834 * gpgme_protocol_t: Protocols and Engines.
2836 * gpgme_protocol_t <1>: Engine Information. (line 7)
2837 * gpgme_pubkey_algo_name: Public Key Algorithms.
2839 * gpgme_pubkey_algo_string: Public Key Algorithms.
2841 * gpgme_pubkey_algo_t: Public Key Algorithms.
2843 * gpgme_query_swdb_result_t: Checking for updates.
2845 * gpgme_recipient_t: Decrypt. (line 75)
2846 * gpgme_register_io_cb_t: I/O Callback Interface.
2848 * gpgme_release: Destroying Contexts. (line 6)
2849 * gpgme_result_ref: Result Management. (line 15)
2850 * gpgme_result_unref: Result Management. (line 23)
2851 * gpgme_set_armor: ASCII Armor. (line 6)
2852 * gpgme_set_ctx_flag: Context Flags. (line 6)
2853 * gpgme_set_engine_info: Engine Configuration.
2855 * gpgme_set_global_flag: Library Version Check.
2857 * gpgme_set_include_certs: Included Certificates.
2859 * gpgme_set_io_cbs: Registering I/O Callbacks.
2861 * gpgme_set_keylist_mode: Key Listing Mode. (line 6)
2862 * gpgme_set_locale: Locale. (line 14)
2863 * gpgme_set_offline: Offline Mode. (line 6)
2864 * gpgme_set_passphrase_cb: Passphrase Callback. (line 40)
2865 * gpgme_set_pinentry_mode: Pinentry Mode. (line 6)
2866 * gpgme_set_progress_cb: Progress Meter Callback.
2868 * gpgme_set_protocol: Protocol Selection. (line 6)
2869 * gpgme_set_sender: Setting the Sender. (line 13)
2870 * gpgme_set_status_cb: Status Message Callback.
2872 * gpgme_set_textmode: Text Mode. (line 6)
2873 * gpgme_signature_t: Verify. (line 92)
2874 * gpgme_signers_add: Selecting Signers. (line 18)
2875 * gpgme_signers_clear: Selecting Signers. (line 11)
2876 * gpgme_signers_count: Selecting Signers. (line 25)
2877 * gpgme_signers_enum: Selecting Signers. (line 31)
2878 * gpgme_sign_result_t: Creating a Signature.
2880 * gpgme_sig_mode_t: Creating a Signature.
2882 * gpgme_sig_notation_add: Signature Notation Data.
2884 * gpgme_sig_notation_clear: Signature Notation Data.
2886 * gpgme_sig_notation_get: Signature Notation Data.
2888 * gpgme_sig_notation_t: Verify. (line 38)
2889 * gpgme_sig_stat_t: Deprecated Functions.
2891 * gpgme_ssize_t: Exchanging Data. (line 32)
2892 * gpgme_status_cb_t: Status Message Callback.
2894 * gpgme_strerror: Error Strings. (line 6)
2895 * gpgme_strerror_r: Error Strings. (line 15)
2896 * gpgme_strsource: Error Strings. (line 26)
2897 * gpgme_subkey_t: Key objects. (line 112)
2898 * gpgme_tofu_info_t: Key objects. (line 275)
2899 * gpgme_tofu_policy_t: Changing TOFU Data. (line 13)
2900 * gpgme_trust_item_get_int_attr: Deprecated Functions.
2902 * gpgme_trust_item_get_string_attr: Deprecated Functions.
2904 * gpgme_trust_item_ref: Manipulating Trust Items.
2906 * gpgme_trust_item_release: Deprecated Functions.
2908 * gpgme_trust_item_t: Trust Item Management.
2910 * gpgme_trust_item_unref: Manipulating Trust Items.
2912 * gpgme_user_id_t: Key objects. (line 217)
2913 * gpgme_validity_t: Information About Keys.
2915 * gpgme_verify_result_t: Verify. (line 268)
2916 * gpgme_wait: Waiting For Completion.
2918 * IMPORT_FILES: UI Server Import/Export Keys.
2920 * INPUT: UI Server Encrypt. (line 23)
2921 * INPUT <1>: UI Server Sign. (line 12)
2922 * INPUT <2>: UI Server Decrypt. (line 12)
2923 * INPUT <3>: UI Server Verify. (line 16)
2924 * MESSAGE: UI Server Verify. (line 10)
2925 * MICALG: UI Server Sign. (line 43)
2926 * off_t (*gpgme_data_seek_cb_t) (void *HANDLE, off_t OFFSET, int WHENCE): Callback Based Data Buffers.
2928 * OUTPUT: UI Server Encrypt. (line 36)
2929 * OUTPUT <1>: UI Server Sign. (line 18)
2930 * OUTPUT <2>: UI Server Decrypt. (line 19)
2931 * OUTPUT <3>: UI Server Verify. (line 23)
2932 * PREP_ENCRYPT: UI Server Encrypt. (line 72)
2933 * PROTOCOL: UI Server Encrypt. (line 98)
2934 * RECIPIENT: UI Server Encrypt. (line 9)
2935 * SENDER: Miscellaneous UI Server Commands.
2937 * SESSION: Miscellaneous UI Server Commands.
2939 * SIGN: UI Server Sign. (line 33)
2940 * SIGN_FILES: UI Server Sign/Encrypt Files.
2942 * SIGSTATUS: UI Server Verify. (line 56)
2943 * ssize_t (*gpgme_data_read_cb_t) (void *HANDLE, void *BUFFER, size_t SIZE): Callback Based Data Buffers.
2945 * ssize_t (*gpgme_data_write_cb_t) (void *HANDLE, const void *BUFFER, size_t SIZE): Callback Based Data Buffers.
2947 * START_CONFDIALOG: Miscellaneous UI Server Commands.
2949 * START_KEYMANAGER: Miscellaneous UI Server Commands.
2951 * struct gpgme_data_cbs: Callback Based Data Buffers.
2953 * struct gpgme_io_cbs: Registering I/O Callbacks.
2955 * VERIFY: UI Server Verify. (line 31)
2956 * VERIFY_FILES: UI Server Verify/Decrypt Files.
2958 * void (*gpgme_data_release_cb_t) (void *HANDLE): Callback Based Data Buffers.
2960 * void (*gpgme_event_io_cb_t) (void *DATA, gpgme_event_io_t TYPE, void *TYPE_DATA): I/O Callback Interface.
2962 * void (*gpgme_progress_cb_t)(void *HOOK, const char *WHAT, int TYPE, int CURRENT, int TOTAL): Progress Meter Callback.
2964 * void (*gpgme_remove_io_cb_t) (void *TAG): I/O Callback Interface.
2966 * window-id: Miscellaneous UI Server Commands.
projects / platform / upstream / gpgme.git / blob