/usr/share/doc/python-slixmpp-doc/html/getting_started/proxy.html is in python-slixmpp-doc 1.2.2-1.1build2.
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 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Enable HTTP Proxy Support — slixmpp</title>
<link rel="stylesheet" href="../_static/haiku.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../',
VERSION: '1.1',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="Send a Message Every 5 Minutes" href="scheduler.html" />
<link rel="prev" title="Mulit-User Chat (MUC) Bot" href="muc.html" />
</head>
<body role="document">
<div class="header" role="banner"><h1 class="heading"><a href="../index.html">
<span>1.1 Documentation</span></a></h1>
<h2 class="heading"><span>Enable HTTP Proxy Support</span></h2>
</div>
<div class="topnav" role="navigation" aria-label="top navigation">
<p>
«  <a href="muc.html">Mulit-User Chat (MUC) Bot</a>
  ::  
<a class="uplink" href="../index.html">Contents</a>
  ::  
<a href="scheduler.html">Send a Message Every 5 Minutes</a>  »
</p>
</div>
<div class="content">
<div class="section" id="enable-http-proxy-support">
<span id="proxy"></span><h1>Enable HTTP Proxy Support<a class="headerlink" href="#enable-http-proxy-support" title="Permalink to this headline">¶</a></h1>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">If you have any issues working through this quickstart guide
join the chat room at <a class="reference external" href="xmpp:slixmpp@muc.poez.io?join">slixmpp@muc.poez.io</a>.</p>
</div>
<p>In some instances, you may wish to route XMPP traffic through
an HTTP proxy, probably to get around restrictive firewalls.
Slixmpp provides support for basic HTTP proxying with DIGEST
authentication.</p>
<p>Enabling proxy support is done in two steps. The first is to instruct Slixmpp
to use a proxy, and the second is to configure the proxy details:</p>
<div class="highlight-python"><div class="highlight"><pre><span></span><span class="n">xmpp</span> <span class="o">=</span> <span class="n">ClientXMPP</span><span class="p">(</span><span class="o">...</span><span class="p">)</span>
<span class="n">xmpp</span><span class="o">.</span><span class="n">use_proxy</span> <span class="o">=</span> <span class="bp">True</span>
<span class="n">xmpp</span><span class="o">.</span><span class="n">proxy_config</span> <span class="o">=</span> <span class="p">{</span>
<span class="s1">'host'</span><span class="p">:</span> <span class="s1">'proxy.example.com'</span><span class="p">,</span>
<span class="s1">'port'</span><span class="p">:</span> <span class="mi">5555</span><span class="p">,</span>
<span class="s1">'username'</span><span class="p">:</span> <span class="s1">'example_user'</span><span class="p">,</span>
<span class="s1">'password'</span><span class="p">:</span> <span class="s1">'******'</span>
<span class="p">}</span>
</pre></div>
</div>
<p>The <code class="docutils literal"><span class="pre">'username'</span></code> and <code class="docutils literal"><span class="pre">'password'</span></code> fields are optional if the proxy does not
require authentication.</p>
<div class="section" id="the-final-product">
<h2>The Final Product<a class="headerlink" href="#the-final-product" title="Permalink to this headline">¶</a></h2>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="ch">#!/usr/bin/env python3</span>
<span class="c1"># -*- coding: utf-8 -*-</span>
<span class="sd">"""</span>
<span class="sd"> Slixmpp: The Slick XMPP Library</span>
<span class="sd"> Copyright (C) 2010 Nathanael C. Fritz</span>
<span class="sd"> This file is part of Slixmpp.</span>
<span class="sd"> See the file LICENSE for copying permission.</span>
<span class="sd">"""</span>
<span class="kn">import</span> <span class="nn">logging</span>
<span class="kn">from</span> <span class="nn">getpass</span> <span class="k">import</span> <span class="n">getpass</span>
<span class="kn">from</span> <span class="nn">argparse</span> <span class="k">import</span> <span class="n">ArgumentParser</span>
<span class="kn">import</span> <span class="nn">slixmpp</span>
<span class="k">class</span> <span class="nc">EchoBot</span><span class="p">(</span><span class="n">slixmpp</span><span class="o">.</span><span class="n">ClientXMPP</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> A simple Slixmpp bot that will echo messages it</span>
<span class="sd"> receives, along with a short thank you message.</span>
<span class="sd"> """</span>
<span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">jid</span><span class="p">,</span> <span class="n">password</span><span class="p">):</span>
<span class="n">slixmpp</span><span class="o">.</span><span class="n">ClientXMPP</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">jid</span><span class="p">,</span> <span class="n">password</span><span class="p">)</span>
<span class="c1"># The session_start event will be triggered when</span>
<span class="c1"># the bot establishes its connection with the server</span>
<span class="c1"># and the XML streams are ready for use. We want to</span>
<span class="c1"># listen for this event so that we we can initialize</span>
<span class="c1"># our roster.</span>
<span class="bp">self</span><span class="o">.</span><span class="n">add_event_handler</span><span class="p">(</span><span class="s2">"session_start"</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">start</span><span class="p">)</span>
<span class="c1"># The message event is triggered whenever a message</span>
<span class="c1"># stanza is received. Be aware that that includes</span>
<span class="c1"># MUC messages and error messages.</span>
<span class="bp">self</span><span class="o">.</span><span class="n">add_event_handler</span><span class="p">(</span><span class="s2">"message"</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">message</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">start</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">event</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Process the session_start event.</span>
<span class="sd"> Typical actions for the session_start event are</span>
<span class="sd"> requesting the roster and broadcasting an initial</span>
<span class="sd"> presence stanza.</span>
<span class="sd"> Arguments:</span>
<span class="sd"> event -- An empty dictionary. The session_start</span>
<span class="sd"> event does not provide any additional</span>
<span class="sd"> data.</span>
<span class="sd"> """</span>
<span class="bp">self</span><span class="o">.</span><span class="n">send_presence</span><span class="p">()</span>
<span class="bp">self</span><span class="o">.</span><span class="n">get_roster</span><span class="p">()</span>
<span class="k">def</span> <span class="nf">message</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">msg</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Process incoming message stanzas. Be aware that this also</span>
<span class="sd"> includes MUC messages and error messages. It is usually</span>
<span class="sd"> a good idea to check the messages's type before processing</span>
<span class="sd"> or sending replies.</span>
<span class="sd"> Arguments:</span>
<span class="sd"> msg -- The received message stanza. See the documentation</span>
<span class="sd"> for stanza objects and the Message stanza to see</span>
<span class="sd"> how it may be used.</span>
<span class="sd"> """</span>
<span class="n">msg</span><span class="o">.</span><span class="n">reply</span><span class="p">(</span><span class="s2">"Thanks for sending</span><span class="se">\n</span><span class="si">%(body)s</span><span class="s2">"</span> <span class="o">%</span> <span class="n">msg</span><span class="p">)</span><span class="o">.</span><span class="n">send</span><span class="p">()</span>
<span class="k">if</span> <span class="vm">__name__</span> <span class="o">==</span> <span class="s1">'__main__'</span><span class="p">:</span>
<span class="c1"># Setup the command line arguments.</span>
<span class="n">parser</span> <span class="o">=</span> <span class="n">ArgumentParser</span><span class="p">()</span>
<span class="c1"># Output verbosity options.</span>
<span class="n">parser</span><span class="o">.</span><span class="n">add_argument</span><span class="p">(</span><span class="s2">"-q"</span><span class="p">,</span> <span class="s2">"--quiet"</span><span class="p">,</span> <span class="n">help</span><span class="o">=</span><span class="s2">"set logging to ERROR"</span><span class="p">,</span>
<span class="n">action</span><span class="o">=</span><span class="s2">"store_const"</span><span class="p">,</span> <span class="n">dest</span><span class="o">=</span><span class="s2">"loglevel"</span><span class="p">,</span>
<span class="n">const</span><span class="o">=</span><span class="n">logging</span><span class="o">.</span><span class="n">ERROR</span><span class="p">,</span> <span class="n">default</span><span class="o">=</span><span class="n">logging</span><span class="o">.</span><span class="n">INFO</span><span class="p">)</span>
<span class="n">parser</span><span class="o">.</span><span class="n">add_argument</span><span class="p">(</span><span class="s2">"-d"</span><span class="p">,</span> <span class="s2">"--debug"</span><span class="p">,</span> <span class="n">help</span><span class="o">=</span><span class="s2">"set logging to DEBUG"</span><span class="p">,</span>
<span class="n">action</span><span class="o">=</span><span class="s2">"store_const"</span><span class="p">,</span> <span class="n">dest</span><span class="o">=</span><span class="s2">"loglevel"</span><span class="p">,</span>
<span class="n">const</span><span class="o">=</span><span class="n">logging</span><span class="o">.</span><span class="n">DEBUG</span><span class="p">,</span> <span class="n">default</span><span class="o">=</span><span class="n">logging</span><span class="o">.</span><span class="n">INFO</span><span class="p">)</span>
<span class="c1"># JID and password options.</span>
<span class="n">parser</span><span class="o">.</span><span class="n">add_argument</span><span class="p">(</span><span class="s2">"-j"</span><span class="p">,</span> <span class="s2">"--jid"</span><span class="p">,</span> <span class="n">dest</span><span class="o">=</span><span class="s2">"jid"</span><span class="p">,</span>
<span class="n">help</span><span class="o">=</span><span class="s2">"JID to use"</span><span class="p">)</span>
<span class="n">parser</span><span class="o">.</span><span class="n">add_argument</span><span class="p">(</span><span class="s2">"-p"</span><span class="p">,</span> <span class="s2">"--password"</span><span class="p">,</span> <span class="n">dest</span><span class="o">=</span><span class="s2">"password"</span><span class="p">,</span>
<span class="n">help</span><span class="o">=</span><span class="s2">"password to use"</span><span class="p">)</span>
<span class="n">parser</span><span class="o">.</span><span class="n">add_argument</span><span class="p">(</span><span class="s2">"--phost"</span><span class="p">,</span> <span class="n">dest</span><span class="o">=</span><span class="s2">"proxy_host"</span><span class="p">,</span>
<span class="n">help</span><span class="o">=</span><span class="s2">"Proxy hostname"</span><span class="p">)</span>
<span class="n">parser</span><span class="o">.</span><span class="n">add_argument</span><span class="p">(</span><span class="s2">"--pport"</span><span class="p">,</span> <span class="n">dest</span><span class="o">=</span><span class="s2">"proxy_port"</span><span class="p">,</span>
<span class="n">help</span><span class="o">=</span><span class="s2">"Proxy port"</span><span class="p">)</span>
<span class="n">parser</span><span class="o">.</span><span class="n">add_argument</span><span class="p">(</span><span class="s2">"--puser"</span><span class="p">,</span> <span class="n">dest</span><span class="o">=</span><span class="s2">"proxy_user"</span><span class="p">,</span>
<span class="n">help</span><span class="o">=</span><span class="s2">"Proxy username"</span><span class="p">)</span>
<span class="n">parser</span><span class="o">.</span><span class="n">add_argument</span><span class="p">(</span><span class="s2">"--ppass"</span><span class="p">,</span> <span class="n">dest</span><span class="o">=</span><span class="s2">"proxy_pass"</span><span class="p">,</span>
<span class="n">help</span><span class="o">=</span><span class="s2">"Proxy password"</span><span class="p">)</span>
<span class="n">args</span> <span class="o">=</span> <span class="n">parser</span><span class="o">.</span><span class="n">parse_args</span><span class="p">()</span>
<span class="c1"># Setup logging.</span>
<span class="n">logging</span><span class="o">.</span><span class="n">basicConfig</span><span class="p">(</span><span class="n">level</span><span class="o">=</span><span class="n">args</span><span class="o">.</span><span class="n">loglevel</span><span class="p">,</span>
<span class="nb">format</span><span class="o">=</span><span class="s1">'</span><span class="si">%(levelname)-8s</span><span class="s1"> </span><span class="si">%(message)s</span><span class="s1">'</span><span class="p">)</span>
<span class="k">if</span> <span class="n">args</span><span class="o">.</span><span class="n">jid</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="n">args</span><span class="o">.</span><span class="n">jid</span> <span class="o">=</span> <span class="nb">input</span><span class="p">(</span><span class="s2">"Username: "</span><span class="p">)</span>
<span class="k">if</span> <span class="n">args</span><span class="o">.</span><span class="n">password</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="n">args</span><span class="o">.</span><span class="n">password</span> <span class="o">=</span> <span class="n">getpass</span><span class="p">(</span><span class="s2">"Password: "</span><span class="p">)</span>
<span class="k">if</span> <span class="n">args</span><span class="o">.</span><span class="n">proxy_host</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="n">args</span><span class="o">.</span><span class="n">proxy_host</span> <span class="o">=</span> <span class="nb">input</span><span class="p">(</span><span class="s2">"Proxy host: "</span><span class="p">)</span>
<span class="k">if</span> <span class="n">args</span><span class="o">.</span><span class="n">proxy_port</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="n">args</span><span class="o">.</span><span class="n">proxy_port</span> <span class="o">=</span> <span class="nb">input</span><span class="p">(</span><span class="s2">"Proxy port: "</span><span class="p">)</span>
<span class="k">if</span> <span class="n">args</span><span class="o">.</span><span class="n">proxy_user</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="n">args</span><span class="o">.</span><span class="n">proxy_user</span> <span class="o">=</span> <span class="nb">input</span><span class="p">(</span><span class="s2">"Proxy username: "</span><span class="p">)</span>
<span class="k">if</span> <span class="n">args</span><span class="o">.</span><span class="n">proxy_pass</span> <span class="ow">is</span> <span class="kc">None</span> <span class="ow">and</span> <span class="n">args</span><span class="o">.</span><span class="n">proxy_user</span><span class="p">:</span>
<span class="n">args</span><span class="o">.</span><span class="n">proxy_pass</span> <span class="o">=</span> <span class="n">getpass</span><span class="p">(</span><span class="s2">"Proxy password: "</span><span class="p">)</span>
<span class="c1"># Setup the EchoBot and register plugins. Note that while plugins may</span>
<span class="c1"># have interdependencies, the order in which you register them does</span>
<span class="c1"># not matter.</span>
<span class="n">xmpp</span> <span class="o">=</span> <span class="n">EchoBot</span><span class="p">(</span><span class="n">args</span><span class="o">.</span><span class="n">jid</span><span class="p">,</span> <span class="n">args</span><span class="o">.</span><span class="n">password</span><span class="p">)</span>
<span class="n">xmpp</span><span class="o">.</span><span class="n">register_plugin</span><span class="p">(</span><span class="s1">'xep_0030'</span><span class="p">)</span> <span class="c1"># Service Discovery</span>
<span class="n">xmpp</span><span class="o">.</span><span class="n">register_plugin</span><span class="p">(</span><span class="s1">'xep_0004'</span><span class="p">)</span> <span class="c1"># Data Forms</span>
<span class="n">xmpp</span><span class="o">.</span><span class="n">register_plugin</span><span class="p">(</span><span class="s1">'xep_0060'</span><span class="p">)</span> <span class="c1"># PubSub</span>
<span class="n">xmpp</span><span class="o">.</span><span class="n">register_plugin</span><span class="p">(</span><span class="s1">'xep_0199'</span><span class="p">)</span> <span class="c1"># XMPP Ping</span>
<span class="n">xmpp</span><span class="o">.</span><span class="n">use_proxy</span> <span class="o">=</span> <span class="kc">True</span>
<span class="n">xmpp</span><span class="o">.</span><span class="n">proxy_config</span> <span class="o">=</span> <span class="p">{</span>
<span class="s1">'host'</span><span class="p">:</span> <span class="n">args</span><span class="o">.</span><span class="n">proxy_host</span><span class="p">,</span>
<span class="s1">'port'</span><span class="p">:</span> <span class="nb">int</span><span class="p">(</span><span class="n">args</span><span class="o">.</span><span class="n">proxy_port</span><span class="p">),</span>
<span class="s1">'username'</span><span class="p">:</span> <span class="n">args</span><span class="o">.</span><span class="n">proxy_user</span><span class="p">,</span>
<span class="s1">'password'</span><span class="p">:</span> <span class="n">args</span><span class="o">.</span><span class="n">proxy_pass</span><span class="p">}</span>
<span class="c1"># Connect to the XMPP server and start processing XMPP stanzas.</span>
<span class="n">xmpp</span><span class="o">.</span><span class="n">connect</span><span class="p">()</span>
<span class="n">xmpp</span><span class="o">.</span><span class="n">process</span><span class="p">()</span>
</pre></div>
</div>
</div>
</div>
</div>
<div class="bottomnav" role="navigation" aria-label="bottom navigation">
<p>
«  <a href="muc.html">Mulit-User Chat (MUC) Bot</a>
  ::  
<a class="uplink" href="../index.html">Contents</a>
  ::  
<a href="scheduler.html">Send a Message Every 5 Minutes</a>  »
</p>
</div>
<div class="footer" role="contentinfo">
© Copyright 2017, Nathan Fritz, Lance Stout.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.5.6.
</div>
</body>
</html>
|