source: general/genlib/libseccomp.xml

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
   "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
  <!ENTITY % general-entities SYSTEM "../../general.ent">
  %general-entities;

  <!ENTITY libseccomp-download-http "https://github.com/seccomp/libseccomp/releases/download/v&libseccomp-version;/libseccomp-&libseccomp-version;.tar.gz">
  <!ENTITY libseccomp-download-ftp  " ">
  <!ENTITY libseccomp-md5sum        "c27a5e43cae1e89e6ebfedeea734c9b4">
  <!ENTITY libseccomp-size          "628 KB">
  <!ENTITY libseccomp-buildsize     "7.1 MB (additional 4.7 MB for tests)">
  <!ENTITY libseccomp-time          "less than 0.1 SBU (additional 2.9 SBU for tests)">
<!-- EDITORS NOTE:
   This library is heavily dependent on system calls at the time of it's release.
   This should be tested with every new minor (v4.13, v4.14, etc.) release
   of the kernel, as it is very finicky and relies on hacks to accomplish
   it's purpose. -->
]>

<sect1 id="libseccomp" xreflabel="libseccomp-&libseccomp-version;">
  <?dbhtml filename="libseccomp.html"?>


  <title>libseccomp-&libseccomp-version;</title>

  <indexterm zone="libseccomp">
    <primary sortas="a-libseccomp">libseccomp</primary>
  </indexterm>

  <sect2 role="package">
    <title>Introduction to libseccomp</title>

    <para>
      The <application>libseccomp</application> package provides an easy to use
      and platform independent interface to the <application>Linux</application>
      kernel's syscall filtering mechanism.
    </para>

    &lfs121_checked;

    <bridgehead renderas="sect3">Package Information</bridgehead>
    <itemizedlist spacing="compact">
      <listitem>
        <para>
          Download (HTTP): <ulink url="&libseccomp-download-http;"/>
        </para>
      </listitem>
      <listitem>
        <para>
          Download (FTP): <ulink url="&libseccomp-download-ftp;"/>
        </para>
      </listitem>
      <listitem>
        <para>
          Download MD5 sum: &libseccomp-md5sum;
        </para>
      </listitem>
      <listitem>
        <para>
          Download size: &libseccomp-size;
        </para>
      </listitem>
      <listitem>
        <para>
          Estimated disk space required: &libseccomp-buildsize;
        </para>
      </listitem>
      <listitem>
        <para>
          Estimated build time: &libseccomp-time;
        </para>
      </listitem>
    </itemizedlist>

    <bridgehead renderas="sect3">libseccomp Dependencies</bridgehead>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <xref linkend="which"/> (needed for tests),
      <xref linkend="valgrind"/>,
      <!--<xref linkend="cython"/> (for python bindings), -->and
      <ulink url="https://github.com/linux-test-project/lcov">LCOV</ulink>
    </para>

  </sect2>

  <sect2 role="installation">
    <title>Installation of libseccomp</title>

    <para>
      Install <application>libseccomp</application> by running the following
      commands:
    </para>

<screen><userinput>./configure --prefix=/usr --disable-static &amp;&amp;
make</userinput></screen>

    <para>
      To test the results, issue: <command>make check</command>.
    </para>

    <para>
      Now, as the <systemitem class="username">root</systemitem> user:
    </para>

<screen role="root"><userinput>make install</userinput></screen>
  </sect2>

  <sect2 role="commands">
    <title>Command Explanations</title>

    <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
      href="../../xincludes/static-libraries.xml"/>
<!--
    <para>
      <option>- -enable-python</option>: this switch is needed to build
      python bindings if <xref linkend="cython"/> is installed.
    </para>
-->
  </sect2>

  <sect2 role="content">
    <title>Contents</title>

    <segmentedlist>
      <segtitle>Installed Program</segtitle>
      <segtitle>Installed Library</segtitle>
      <segtitle>Installed Directories</segtitle>

      <seglistitem>
        <seg>
          scmp_sys_resolver
        </seg>
        <seg>
          libseccomp.so
        </seg>
        <seg>
          None
        </seg>
      </seglistitem>
    </segmentedlist>

    <variablelist>
      <bridgehead renderas="sect3">Short Descriptions</bridgehead>
      <?dbfo list-presentation="list"?>
      <?dbhtml list-presentation="table"?>

      <varlistentry id="scmp_sys_resolver">
        <term><command>scmp_sys_resolver</command></term>
        <listitem>
          <para>
            is used to resolve system calls for applications
          </para>
          <indexterm zone="libseccomp scmp_sys_resolver">
            <primary sortas="b-scmp_sys_resolver">scmp_sys_resolver</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libseccomp-lib">
        <term><filename class="libraryfile">libseccomp.so</filename></term>
        <listitem>
          <para>
            contains API functions for translating syscalls
          </para>
          <indexterm zone="libseccomp libseccomp-lib">
            <primary sortas="c-libseccomp-lib">libseccomp.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>
    </variablelist>
  </sect2>

</sect1>