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