summaryrefslogtreecommitdiff
path: root/demos
diff options
context:
space:
mode:
authorJeff Forcier <jeff@bitprophet.org>2014-09-08 17:10:56 -0700
committerJeff Forcier <jeff@bitprophet.org>2014-09-08 17:10:56 -0700
commitf8355eed688b1b2e0a0c23ab9a210fd8b8be4a96 (patch)
tree9ab619ad485a8cd68aff37f282405662cb3fad4d /demos
parentea9c1d2801440f8bc8859f1c3638033b09a86fa2 (diff)
downloadparamiko-f8355eed688b1b2e0a0c23ab9a210fd8b8be4a96.tar.gz
Fix outdated reference syntax in a demo
Diffstat (limited to 'demos')
-rw-r--r--demos/demo_server.py21
1 files changed, 12 insertions, 9 deletions
diff --git a/demos/demo_server.py b/demos/demo_server.py
index 74e4677e..5b3d5164 100644
--- a/demos/demo_server.py
+++ b/demos/demo_server.py
@@ -71,15 +71,18 @@ class Server (paramiko.ServerInterface):
gss_authenticated=paramiko.AUTH_FAILED,
cc_file=None):
"""
- @note: We are just checking in L{AuthHandler} that the given user is
- a valid krb5 principal!
- We don't check if the krb5 principal is allowed to log in on
- the server, because there is no way to do that in python. So
- if you develop your own SSH server with paramiko for a certain
- platform like Linux, you should call C{krb5_kuserok()} in your
- local kerberos library to make sure that the krb5_principal has
- an account on the server and is allowed to log in as a user.
- @see: U{krb5_kuserok() man page <http://www.unix.com/man-page/all/3/krb5_kuserok/>}
+ .. note::
+ We are just checking in `AuthHandler` that the given user is a
+ valid krb5 principal! We don't check if the krb5 principal is
+ allowed to log in on the server, because there is no way to do that
+ in python. So if you develop your own SSH server with paramiko for
+ a certain platform like Linux, you should call ``krb5_kuserok()`` in
+ your local kerberos library to make sure that the krb5_principal
+ has an account on the server and is allowed to log in as a user.
+
+ .. seealso::
+ `krb5_kuserok() man page
+ <http://www.unix.com/man-page/all/3/krb5_kuserok/>`_
"""
if gss_authenticated == paramiko.AUTH_SUCCESSFUL:
return paramiko.AUTH_SUCCESSFUL