[ab4fdfc] | 1 | <?xml version="1.0" encoding="UTF-8"?>
|
---|
[f1ce80b] | 2 | <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
|
---|
| 3 | "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
|
---|
| 4 | <!ENTITY % general-entities SYSTEM "../../general.ent">
|
---|
| 5 | %general-entities;
|
---|
| 6 |
|
---|
[8dfc5c3] | 7 | <!ENTITY liboauth-download-http "&sourceforge-dl;/liboauth/liboauth-&liboauth-version;.tar.gz">
|
---|
[f1ce80b] | 8 | <!ENTITY liboauth-download-ftp " ">
|
---|
| 9 | <!ENTITY liboauth-md5sum "689b46c2b3ab1a39735ac33f714c4f7f">
|
---|
| 10 | <!ENTITY liboauth-size "496 KB">
|
---|
| 11 | <!ENTITY liboauth-buildsize "3.5 MB">
|
---|
| 12 | <!ENTITY liboauth-time "less than 0.1 SBU">
|
---|
| 13 | ]>
|
---|
| 14 |
|
---|
[e130fead] | 15 | <sect1 id="liboauth" xreflabel="liboauth-&liboauth-version;">
|
---|
[f1ce80b] | 16 | <?dbhtml filename="liboauth.html"?>
|
---|
| 17 |
|
---|
| 18 |
|
---|
| 19 | <title>liboauth-&liboauth-version;</title>
|
---|
| 20 |
|
---|
| 21 | <indexterm zone="liboauth">
|
---|
| 22 | <primary sortas="a-liboauth">liboauth</primary>
|
---|
| 23 | </indexterm>
|
---|
| 24 |
|
---|
| 25 | <sect2 role="package">
|
---|
| 26 | <title>Introduction to liboauth</title>
|
---|
| 27 |
|
---|
| 28 | <para>
|
---|
| 29 | <application>liboauth</application> is a collection of POSIX-C functions
|
---|
| 30 | implementing the OAuth Core RFC 5849 standard. Liboauth provides functions
|
---|
| 31 | to escape and encode parameters according to OAuth specification and
|
---|
| 32 | offers high-level functionality to sign requests or verify OAuth signatures
|
---|
| 33 | as well as perform HTTP requests.
|
---|
| 34 | </para>
|
---|
| 35 |
|
---|
[4c0efc3c] | 36 | &lfs122_checked;
|
---|
[f1ce80b] | 37 |
|
---|
| 38 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
| 39 | <itemizedlist spacing="compact">
|
---|
| 40 | <listitem>
|
---|
| 41 | <para>
|
---|
| 42 | Download (HTTP): <ulink url="&liboauth-download-http;"/>
|
---|
| 43 | </para>
|
---|
| 44 | </listitem>
|
---|
| 45 | <listitem>
|
---|
| 46 | <para>
|
---|
| 47 | Download (FTP): <ulink url="&liboauth-download-ftp;"/>
|
---|
| 48 | </para>
|
---|
| 49 | </listitem>
|
---|
| 50 | <listitem>
|
---|
| 51 | <para>
|
---|
| 52 | Download MD5 sum: &liboauth-md5sum;
|
---|
| 53 | </para>
|
---|
| 54 | </listitem>
|
---|
| 55 | <listitem>
|
---|
| 56 | <para>
|
---|
| 57 | Download size: &liboauth-size;
|
---|
| 58 | </para>
|
---|
| 59 | </listitem>
|
---|
| 60 | <listitem>
|
---|
| 61 | <para>
|
---|
| 62 | Estimated disk space required: &liboauth-buildsize;
|
---|
| 63 | </para>
|
---|
| 64 | </listitem>
|
---|
| 65 | <listitem>
|
---|
| 66 | <para>
|
---|
| 67 | Estimated build time: &liboauth-time;
|
---|
| 68 | </para>
|
---|
| 69 | </listitem>
|
---|
| 70 | </itemizedlist>
|
---|
| 71 |
|
---|
[361352f] | 72 | <bridgehead renderas="sect3">Additional Downloads</bridgehead>
|
---|
[a4f37269] | 73 | <itemizedlist spacing="compact">
|
---|
| 74 | <listitem>
|
---|
[47274444] | 75 | <para>
|
---|
| 76 | Required patch for use with openssl: <ulink url=
|
---|
| 77 | "&patch-root;/liboauth-&liboauth-version;-openssl-1.1.0-3.patch"/>
|
---|
[a4f37269] | 78 | </para>
|
---|
| 79 | </listitem>
|
---|
| 80 | </itemizedlist>
|
---|
| 81 |
|
---|
[f1ce80b] | 82 | <bridgehead renderas="sect3">liboauth Dependencies</bridgehead>
|
---|
| 83 |
|
---|
| 84 | <bridgehead renderas="sect4">Required</bridgehead>
|
---|
| 85 | <para role="required">
|
---|
[8558044] | 86 | <xref linkend="curl"/>
|
---|
[f1ce80b] | 87 | </para>
|
---|
| 88 |
|
---|
| 89 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
| 90 | <para role="optional">
|
---|
[94b42903] | 91 | <xref linkend="nss"/> and
|
---|
[f1ce80b] | 92 | <xref linkend="doxygen"/> (to build documentation)
|
---|
| 93 | </para>
|
---|
| 94 |
|
---|
| 95 | </sect2>
|
---|
| 96 |
|
---|
| 97 | <sect2 role="installation">
|
---|
| 98 | <title>Installation of liboauth</title>
|
---|
| 99 |
|
---|
[a4f37269] | 100 | <para>
|
---|
[94b42903] | 101 | Apply a patch for the current version of openssl:
|
---|
[a4f37269] | 102 | </para>
|
---|
| 103 |
|
---|
[e130fead] | 104 | <screen><userinput>patch -Np1 -i ../liboauth-&liboauth-version;-openssl-1.1.0-3.patch</userinput></screen>
|
---|
[a4f37269] | 105 |
|
---|
[f1ce80b] | 106 | <para>
|
---|
| 107 | Install <application>liboauth</application> by running the following
|
---|
| 108 | commands:
|
---|
| 109 | </para>
|
---|
| 110 |
|
---|
| 111 | <screen><userinput>./configure --prefix=/usr --disable-static &&
|
---|
| 112 | make</userinput></screen>
|
---|
| 113 |
|
---|
| 114 | <para>
|
---|
[a42c273] | 115 | If you wish to build the documentation (needs <xref linkend="doxygen"/>),
|
---|
| 116 | issue:
|
---|
[f1ce80b] | 117 | </para>
|
---|
| 118 |
|
---|
[a42c273] | 119 | <screen remap="doc"><userinput>make dox</userinput></screen>
|
---|
| 120 |
|
---|
[f1ce80b] | 121 | <para>
|
---|
[e130fead] | 122 | To test the results, issue: <command>make check</command>.
|
---|
[f1ce80b] | 123 | </para>
|
---|
| 124 |
|
---|
| 125 | <para>
|
---|
| 126 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
| 127 | </para>
|
---|
| 128 |
|
---|
| 129 | <screen role="root"><userinput>make install</userinput></screen>
|
---|
| 130 |
|
---|
| 131 | <para>
|
---|
| 132 | If you have previously built the documentation, install it by
|
---|
| 133 | running the following commands as the
|
---|
| 134 | <systemitem class="username">root</systemitem> user:
|
---|
| 135 | </para>
|
---|
| 136 |
|
---|
[a42c273] | 137 | <screen role="root"
|
---|
| 138 | remap="doc"><userinput>install -v -dm755 /usr/share/doc/liboauth-&liboauth-version; &&
|
---|
[f1ce80b] | 139 | cp -rv doc/html/* /usr/share/doc/liboauth-&liboauth-version;</userinput></screen>
|
---|
| 140 |
|
---|
| 141 | </sect2>
|
---|
| 142 |
|
---|
| 143 | <sect2 role="commands">
|
---|
| 144 | <title>Command Explanations</title>
|
---|
| 145 |
|
---|
| 146 | <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
|
---|
| 147 | href="../../xincludes/static-libraries.xml"/>
|
---|
| 148 |
|
---|
| 149 | <para>
|
---|
| 150 | <option>--enable-nss</option>: Use this switch if you want to
|
---|
| 151 | use Mozilla NSS instead of <application>OpenSSL</application>.
|
---|
| 152 | </para>
|
---|
| 153 |
|
---|
| 154 | </sect2>
|
---|
| 155 |
|
---|
| 156 | <sect2 role="content">
|
---|
| 157 | <title>Contents</title>
|
---|
| 158 |
|
---|
| 159 | <segmentedlist>
|
---|
| 160 | <segtitle>Installed Programs</segtitle>
|
---|
| 161 | <segtitle>Installed Libraries</segtitle>
|
---|
| 162 | <segtitle>Installed Directories</segtitle>
|
---|
| 163 |
|
---|
| 164 | <seglistitem>
|
---|
| 165 | <seg>
|
---|
| 166 | None
|
---|
| 167 | </seg>
|
---|
| 168 | <seg>
|
---|
| 169 | liboauth.so
|
---|
| 170 | </seg>
|
---|
| 171 | <seg>
|
---|
| 172 | /usr/share/doc/liboauth-&liboauth-version;
|
---|
| 173 | </seg>
|
---|
| 174 | </seglistitem>
|
---|
| 175 | </segmentedlist>
|
---|
| 176 |
|
---|
| 177 | <variablelist>
|
---|
| 178 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 179 | <?dbfo list-presentation="list"?>
|
---|
| 180 | <?dbhtml list-presentation="table"?>
|
---|
| 181 |
|
---|
| 182 | <varlistentry id="liboauth-lib">
|
---|
| 183 | <term><filename class="libraryfile">liboauth.so</filename></term>
|
---|
| 184 | <listitem>
|
---|
| 185 | <para>
|
---|
[96923ef] | 186 | provides functions to escape and encode strings according to
|
---|
[f1ce80b] | 187 | OAuth specifications and offers high-level functionality built
|
---|
| 188 | on top to sign requests or verify signatures using either NSS or
|
---|
[4c24eb0a] | 189 | OpenSSL for calculating the hash/signatures
|
---|
[f1ce80b] | 190 | </para>
|
---|
| 191 | <indexterm zone="liboauth liboauth-lib">
|
---|
| 192 | <primary sortas="c-liboauth">liboauth.so</primary>
|
---|
| 193 | </indexterm>
|
---|
| 194 | </listitem>
|
---|
| 195 | </varlistentry>
|
---|
| 196 |
|
---|
| 197 | </variablelist>
|
---|
| 198 |
|
---|
| 199 | </sect2>
|
---|
| 200 |
|
---|
| 201 | </sect1>
|
---|