Core API

This API provides detailed control over all aspects of the SDK. More...

Modules
	Read OpenPGP packets
	Readers
	Write OpenPGP packets
	Writers
	Error Handling
	Keys and Keyrings
	Hashes
	Encryption/Decryption
	Signatures/Verification
	Compression/Decompression
	Functions to do with MPIs
	Print
	Linked Lists
	Memory
	Callbacks
	These callback functions are used when parsing or creating.
	Create
	These functions allow an OpenPGP object to be created.

---

Detailed Description

This API provides detailed control over all aspects of the SDK.

You may find that the easier-to-use High Level API meets your needs.

Please note that the Core API documentation is still a Work-In-Progress.

If you are using the Core API for the first time, you may find that the best place to start if by finding an existing function which does most of what you need and modifying it. A good place to look for such a function is in the test suite (openpgpsdk/tests).

To Read OpenPGP packets

• Read OpenPGP packets
• Readers

Usage 1 : To Parse an input stream (discarding parsed data)

• Configure an ops_parse_options_t structure
  • Set "Reader" function and args (to get the data)
  • Set "Callback" function and args (to do something useful with the parsed data)
• Call ops_parse_options() to specify whether individual subpacket types are to parsed, left raw or ignored
• Finally, call ops_parse()

Usage 2 : To Parse an input stream (storing parsed data in keyring)

• Get keyring
• Configure an ops_parse_options_t structure
  • Set "Reader" function and args (to get the data)
  • No need to set "Callback" function and args
• No need to call ops_parse_options() to specify whether individual subpacket types are to parsed, left raw or ignored
• Call ops_parse_and_accumulate() to populate keyring
• Don't forget to call ops_keyring_free() when you've finished with the keyring to release the memory.

---