This file is indexed.

/usr/share/doc/libfko-doc/libfko.html/index.html is in libfko-doc 2.6.9-2.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below.

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<!-- 
This manual is for the Firewall Knock Operator library, libfko.
(version 2.6.9, last updated 9 June 2016).

Copyright (C) 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 -->
<!-- Created by GNU Texinfo 6.5, http://www.gnu.org/software/texinfo/ -->
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>Top (Firewall Knock Operator Library - libfko)</title>

<meta name="description" content="Top (Firewall Knock Operator Library - libfko)">
<meta name="keywords" content="Top (Firewall Knock Operator Library - libfko)">
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
<link href="#Top" rel="start" title="Top">
<link href="Concept-Index.html#Concept-Index" rel="index" title="Concept Index">
<link href="#SEC_Contents" rel="contents" title="Table of Contents">
<link href="../dir/index.html" rel="up" title="(dir)">
<link href="Introduction.html#Introduction" rel="next" title="Introduction">
<style type="text/css">
<!--
a.summary-letter {text-decoration: none}
blockquote.indentedblock {margin-right: 0em}
blockquote.smallindentedblock {margin-right: 0em; font-size: smaller}
blockquote.smallquotation {font-size: smaller}
div.display {margin-left: 3.2em}
div.example {margin-left: 3.2em}
div.lisp {margin-left: 3.2em}
div.smalldisplay {margin-left: 3.2em}
div.smallexample {margin-left: 3.2em}
div.smalllisp {margin-left: 3.2em}
kbd {font-style: oblique}
pre.display {font-family: inherit}
pre.format {font-family: inherit}
pre.menu-comment {font-family: serif}
pre.menu-preformatted {font-family: serif}
pre.smalldisplay {font-family: inherit; font-size: smaller}
pre.smallexample {font-size: smaller}
pre.smallformat {font-family: inherit; font-size: smaller}
pre.smalllisp {font-size: smaller}
span.nolinebreak {white-space: nowrap}
span.roman {font-family: initial; font-weight: normal}
span.sansserif {font-family: sans-serif; font-weight: normal}
ul.no-bullet {list-style: none}
-->
</style>


</head>

<body lang="en">
<h1 class="settitle" align="center">Firewall Knock Operator Library - libfko</h1>






<a name="SEC_Contents"></a>
<h2 class="contents-heading">Table of Contents</h2>

<div class="contents">

<ul class="no-bullet">
  <li><a name="toc-Introduction-1" href="Introduction.html#Introduction">1 Introduction</a>
  <ul class="no-bullet">
    <li><a name="toc-Getting-Started-1" href="Getting-Started.html#Getting-Started">1.1 Getting Started</a></li>
    <li><a name="toc-Features-1" href="Features.html#Features">1.2 Features</a></li>
    <li><a name="toc-Overview-1" href="Overview.html#Overview">1.3 Overview</a>
    <ul class="no-bullet">
      <li><a name="toc-SPA-Data-Format-1" href="SPA-Data-Format.html#SPA-Data-Format">1.3.1 SPA Data Format</a></li>
    </ul></li>
  </ul></li>
  <li><a name="toc-Preparation-1" href="Preparation.html#Preparation">2 Preparation</a>
  <ul class="no-bullet">
    <li><a name="toc-libfko-Header-1" href="libfko-Header.html#libfko-Header">2.1 libfko Header</a></li>
    <li><a name="toc-Compiling-with-libfko-1" href="Compiling-with-libfko.html#Compiling-with-libfko">2.2 Compiling with libfko</a></li>
    <li><a name="toc-SPA-Parameter-Types-1" href="SPA-Parameter-Types.html#SPA-Parameter-Types">2.3 SPA Parameter Types</a>
    <ul class="no-bullet">
      <li><a name="toc-Digests-1" href="Digests.html#Digests">2.3.1 Digests</a></li>
      <li><a name="toc-SPA-Messages-1" href="SPA-Messages.html#SPA-Messages">2.3.2 SPA Messages</a></li>
      <li><a name="toc-Encryption-Algorithms-1" href="Encryption-Algorithms.html#Encryption-Algorithms">2.3.3 Encryption Algorithms</a></li>
      <li><a name="toc-HMAC-Digests-1" href="HMAC-Digests.html#HMAC-Digests">2.3.4 HMAC Digests</a></li>
    </ul></li>
  </ul></li>
  <li><a name="toc-Using-libfko-1" href="Using-libfko.html#Using-libfko">3 Using libfko</a>
  <ul class="no-bullet">
    <li><a name="toc-Creating-Contexts-1" href="Creating-Contexts.html#Creating-Contexts">3.1 Creating Contexts</a></li>
    <li><a name="toc-Destroying-Contexts-1" href="Destroying-Contexts.html#Destroying-Contexts">3.2 Destroying Contexts</a></li>
    <li><a name="toc-Creating-a-SPA-Message-1" href="Creating-a-SPA-Message.html#Creating-a-SPA-Message">3.3 Creating a SPA Message</a></li>
    <li><a name="toc-Setting-SPA-Data-1" href="Setting-SPA-Data.html#Setting-SPA-Data">3.4 Setting SPA Data</a></li>
    <li><a name="toc-Retrieving-SPA-Data-1" href="Retrieving-SPA-Data.html#Retrieving-SPA-Data">3.5 Retrieving SPA Data</a></li>
    <li><a name="toc-Utility-Functions-1" href="Utility-Functions.html#Utility-Functions">3.6 Utility Functions</a></li>
    <li><a name="toc-Error-Handling-1" href="Error-Handling.html#Error-Handling">3.7 Error Handling</a></li>
  </ul></li>
  <li><a name="toc-GNU-GENERAL-PUBLIC-LICENSE" href="Library-Copying.html#Library-Copying">Appendix A GNU GENERAL PUBLIC LICENSE</a>
  <ul class="no-bullet">
    <li><a name="toc-Preamble" href="Library-Copying.html#Preamble">A.1 Preamble</a></li>
    <li><a name="toc-Appendix_003a-How-to-Apply-These-Terms-to-Your-New-Programs" href="Library-Copying.html#Appendix_003a-How-to-Apply-These-Terms-to-Your-New-Programs">A.2 Appendix: How to Apply These Terms to Your New Programs</a></li>
  </ul></li>
  <li><a name="toc-Concept-Index-1" href="Concept-Index.html#Concept-Index">Concept Index</a></li>
  <li><a name="toc-Function-and-Data-Index-1" href="Function-and-Data-Index.html#Function-and-Data-Index">Function and Data Index</a></li>
</ul>
</div>


<a name="Top"></a>
<div class="header">
<p>
Next: <a href="Introduction.html#Introduction" accesskey="n" rel="next">Introduction</a>, Up: <a href="../dir/index.html" accesskey="u" rel="up">(dir)</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Concept-Index.html#Concept-Index" title="Index" rel="index">Index</a>]</p>
</div>
<hr>
<a name="Main-Menu"></a>
<h1 class="top">Main Menu</h1>

<p>This manual is for the Firewall Knock Operator library, libfko.
(version 2.6.9, last updated 9 June 2016).
</p>
<p>Copyright &copy; 2009-2013 Damien Stuart.
</p>
<blockquote>
<p>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.
</p>
<p>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.
</p>
<p>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
</p></blockquote>


<table class="menu" border="0" cellspacing="0">
<tr><td align="left" valign="top">&bull; <a href="Introduction.html#Introduction" accesskey="1">Introduction</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">How to use this manual
</td></tr>
<tr><td align="left" valign="top">&bull; <a href="Preparation.html#Preparation" accesskey="2">Preparation</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">What you should do before using the library
</td></tr>
<tr><td align="left" valign="top">&bull; <a href="Using-libfko.html#Using-libfko" accesskey="3">Using libfko</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">How to use libfko in your program
</td></tr>
<tr><th colspan="3" align="left" valign="top"><pre class="menu-comment">

Appendices

</pre></th></tr><tr><td align="left" valign="top">&bull; <a href="Library-Copying.html#Library-Copying" accesskey="4">Library Copying</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">The GNU General Public License says
                                  how you can copy and share
Indices
</td></tr>
<tr><th colspan="3" align="left" valign="top"><pre class="menu-comment">

</pre></th></tr><tr><td align="left" valign="top">&bull; <a href="Concept-Index.html#Concept-Index" accesskey="5">Concept Index</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">Index of concepts and programs
</td></tr>
<tr><td align="left" valign="top">&bull; <a href="Function-and-Data-Index.html#Function-and-Data-Index" accesskey="6">Function and Data Index</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">Index of functions, variables and data types
</td></tr>
<tr><th colspan="3" align="left" valign="top"><pre class="menu-comment">

</pre></th></tr><tr><th colspan="3" align="left" valign="top"><pre class="menu-comment"> &mdash; The Detailed Node Listing &mdash;

Introduction

</pre></th></tr><tr><td align="left" valign="top">&bull; <a href="Getting-Started.html#Getting-Started" accesskey="7">Getting Started</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">Purpose of the manual, and how to use it
</td></tr>
<tr><td align="left" valign="top">&bull; <a href="Features.html#Features" accesskey="8">Features</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">Reasons to install and use libfko
</td></tr>
<tr><td align="left" valign="top">&bull; <a href="Overview.html#Overview" accesskey="9">Overview</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">Basic overview of <acronym>SPA</acronym> and
                                  architecture of the libfko library
</td></tr>
<tr><th colspan="3" align="left" valign="top"><pre class="menu-comment">

Overview

</pre></th></tr><tr><td align="left" valign="top">&bull; <a href="SPA-Data-Format.html#SPA-Data-Format">SPA Data Format</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">Description of the <acronym>SPA</acronym> data
                                  format.
</td></tr>
<tr><th colspan="3" align="left" valign="top"><pre class="menu-comment">

Preparation

</pre></th></tr><tr><td align="left" valign="top">&bull; <a href="libfko-Header.html#libfko-Header">libfko Header</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">What header file you need to include
</td></tr>
<tr><td align="left" valign="top">&bull; <a href="Compiling-with-libfko.html#Compiling-with-libfko">Compiling with libfko</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">What you need to compile and link your
                                  program with libfko
</td></tr>
<tr><td align="left" valign="top">&bull; <a href="SPA-Parameter-Types.html#SPA-Parameter-Types">SPA Parameter Types</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">The available digests, message types and
                                  modes of encryption for <acronym>SPA</acronym> data
Using libfko
</td></tr>
<tr><th colspan="3" align="left" valign="top"><pre class="menu-comment">

</pre></th></tr><tr><td align="left" valign="top">&bull; <a href="Creating-Contexts.html#Creating-Contexts">Creating Contexts</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">Creating a new fko context
</td></tr>
<tr><td align="left" valign="top">&bull; <a href="Destroying-Contexts.html#Destroying-Contexts">Destroying Contexts</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">Releasing an fko context
</td></tr>
<tr><td align="left" valign="top">&bull; <a href="Creating-a-SPA-Message.html#Creating-a-SPA-Message">Creating a SPA Message</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">What it takes to create a <acronym>SPA</acronym>
                                  message
</td></tr>
<tr><td align="left" valign="top">&bull; <a href="Setting-SPA-Data.html#Setting-SPA-Data">Setting SPA Data</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">Setting <acronym>SPA</acronym> data
</td></tr>
<tr><td align="left" valign="top">&bull; <a href="Retrieving-SPA-Data.html#Retrieving-SPA-Data">Retrieving SPA Data</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">Retrieving <acronym>SPA</acronym> data
</td></tr>
<tr><td align="left" valign="top">&bull; <a href="Utility-Functions.html#Utility-Functions">Utility Functions</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">Other utility, miscellaneous, and seldom
                                  used functions
</td></tr>
<tr><td align="left" valign="top">&bull; <a href="Error-Handling.html#Error-Handling">Error Handling</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">Possible errors and their meaning
</td></tr>
<tr><th colspan="3" align="left" valign="top"><pre class="menu-comment">

SPA Parameter Types

</pre></th></tr><tr><td align="left" valign="top">&bull; <a href="Digests.html#Digests">Digests</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">The message digest hashes supported by libfko
</td></tr>
<tr><td align="left" valign="top">&bull; <a href="SPA-Messages.html#SPA-Messages">SPA Messages</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">The fko <acronym>SPA</acronym> message types
                                  supported by libfko (and fwknop)
</td></tr>
<tr><td align="left" valign="top">&bull; <a href="Encryption-Algorithms.html#Encryption-Algorithms">Encryption Algorithms</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">Encryption schemes supported by libfko
</td></tr>
<tr><td align="left" valign="top">&bull; <a href="HMAC-Digests.html#HMAC-Digests">HMAC Digests</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">Digests that can be used to build an HMAC
</td></tr>
<tr><th colspan="3" align="left" valign="top"><pre class="menu-comment">

</pre></th></tr></table>

<hr>
<div class="header">
<p>
Next: <a href="Introduction.html#Introduction" accesskey="n" rel="next">Introduction</a>, Up: <a href="../dir/index.html" accesskey="u" rel="up">(dir)</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Concept-Index.html#Concept-Index" title="Index" rel="index">Index</a>]</p>
</div>



</body>
</html>