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