Next: Introduction, Up: (dir) [Contents][Index]
This manual is for the Firewall Knock Operator library, libfko. (version 2.6.9, last updated 9 June 2016).
Copyright © 2009-2013 Damien Stuart.
The libfko manual is free; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.
The libfko manual is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License along with this manual; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
• Introduction: | How to use this manual | |
• Preparation: | What you should do before using the library | |
• Using libfko: | How to use libfko in your program | |
Appendices | ||
---|---|---|
• Library Copying: | The GNU General Public License says how you can copy and share Indices | |
• Concept Index: | Index of concepts and programs | |
• Function and Data Index: | Index of functions, variables and data types | |
— The Detailed Node Listing — Introduction | ||
• Getting Started: | Purpose of the manual, and how to use it | |
• Features: | Reasons to install and use libfko | |
• Overview: | Basic overview of SPA and architecture of the libfko library | |
Overview | ||
• SPA Data Format: | Description of the SPA data format. | |
Preparation | ||
• libfko Header: | What header file you need to include | |
• Compiling with libfko: | What you need to compile and link your program with libfko | |
• SPA Parameter Types: | The available digests, message types and modes of encryption for SPA data Using libfko | |
• Creating Contexts: | Creating a new fko context | |
• Destroying Contexts: | Releasing an fko context | |
• Creating a SPA Message: | What it takes to create a SPA message | |
• Setting SPA Data: | Setting SPA data | |
• Retrieving SPA Data: | Retrieving SPA data | |
• Utility Functions: | Other utility, miscellaneous, and seldom used functions | |
• Error Handling: | Possible errors and their meaning | |
SPA Parameter Types | ||
• Digests: | The message digest hashes supported by libfko | |
• SPA Messages: | The fko SPA message types supported by libfko (and fwknop) | |
• Encryption Algorithms: | Encryption schemes supported by libfko | |
• HMAC Digests: | Digests that can be used to build an HMAC | |
Next: Introduction, Up: (dir) [Contents][Index]