[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PATCH v2] python: Add Python bindings for libgsasl
|
From: |
David Michael |
|
Subject: |
[PATCH v2] python: Add Python bindings for libgsasl |
|
Date: |
Mon, 10 Aug 2015 18:31:30 -0400 |
This change adds a Python module that provides an interface to the
main libgsasl functions. It is compatible with any Python versions
2.6 or later, including Python 3.
* __init__.py: The Pythonic interface to libgsasl is provided by
this file. It imports enum.py for named numerical constants.
* enum.py: Enumerations found in gsasl.h were converted to the
Python dictionaries defined in this file.
* tests.py: This file can be run through a Python interpreter to
verify that all of the functions provided by __init__.py can be
called and return successfully. It needs at least Python 2.7.
Some files are also included to build the module for distribution
with PyPI. Note that although the module is named "gsasl", the
project name for PyPI is "pygsasl" to avoid naming conflicts with
the main gsasl project's source archives, etc.
* LICENSE: This provides the full text of the module's license.
* MANIFEST.in: Include the license text in source distributions.
* README.rst: A description of the module, its requirements, and
an example of how to use it are provided by this document.
* setup.cfg: Declare that this module should produce universal
wheels, i.e. it supports both Python 2 and Python 3 natively.
* setup.py: Configure the module installer and its metadata.
These gsasl files were modified to include the above.
* .gitignore: Compiled Python files and those created during
builds with distutils/setuptools are now ignored.
* lib/Makefile.am: The Python files are appended to EXTRA_DIST
so they are included in the library's release archives.
---
Changes since v1:
- Added a static enum.py instead of having the build generate it.
- Removed the automake build/install of the Python module.
- Added an independent Python distutils/setuptools build system.
- Included the module for distribution in the library's Makefile.
(I'm resending this; Emacs printed a GnuTLS error when I tried to send
it, and it doesn't look like it went through. Sorry if you get multiple
copies of this.)
.gitignore | 6 +
lib/Makefile.am | 5 +
lib/python/LICENSE | 502 +++++++++++++++++++++++++++++++++++++++++++
lib/python/MANIFEST.in | 1 +
lib/python/README.rst | 58 +++++
lib/python/gsasl/__init__.py | 411 +++++++++++++++++++++++++++++++++++
lib/python/gsasl/enum.py | 132 ++++++++++++
lib/python/gsasl/tests.py | 200 +++++++++++++++++
lib/python/setup.cfg | 2 +
lib/python/setup.py | 42 ++++
10 files changed, 1359 insertions(+)
create mode 100644 lib/python/LICENSE
create mode 100644 lib/python/MANIFEST.in
create mode 100644 lib/python/README.rst
create mode 100644 lib/python/gsasl/__init__.py
create mode 100644 lib/python/gsasl/enum.py
create mode 100644 lib/python/gsasl/tests.py
create mode 100644 lib/python/setup.cfg
create mode 100644 lib/python/setup.py
diff --git a/.gitignore b/.gitignore
index d41560b..48d1d48 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,7 +1,9 @@
*.gcda
*.gcno
*.gcov
+*.py[cdo]
*~
+__pycache__/
ABOUT-NLS
ChangeLog
INSTALL
@@ -846,6 +848,10 @@ lib/po/quot.sed
lib/po/remove-potcdate.sed
lib/po/remove-potcdate.sin
lib/po/stamp-po
+lib/python/*.egg-info/
+lib/python/build/
+lib/python/dist/
+lib/python/MANIFEST
lib/saml20/.deps/
lib/saml20/.libs/
lib/saml20/Makefile
diff --git a/lib/Makefile.am b/lib/Makefile.am
index 88298d7..792df3e 100644
--- a/lib/Makefile.am
+++ b/lib/Makefile.am
@@ -31,6 +31,11 @@ EXTRA_DIST += win32/libgsasl.sln win32/libgsasl.vcproj
\
win32/include/stdint.h win32/include/unistd.h \
win32/include/config.h
+# Python module files.
+EXTRA_DIST += python/gsasl/__init__.py python/gsasl/enum.py \
+ python/gsasl/tests.py python/setup.py python/setup.cfg \
+ python/LICENSE python/MANIFEST.in python/README.rst
+
SUBDIRS = po gl
# Plugins:
diff --git a/lib/python/LICENSE b/lib/python/LICENSE
new file mode 100644
index 0000000..4362b49
--- /dev/null
+++ b/lib/python/LICENSE
@@ -0,0 +1,502 @@
+ GNU LESSER GENERAL PUBLIC LICENSE
+ Version 2.1, February 1999
+
+ Copyright (C) 1991, 1999 Free Software Foundation, Inc.
+ 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+[This is the first released version of the Lesser GPL. It also counts
+ as the successor of the GNU Library Public License, version 2, hence
+ the version number 2.1.]
+
+ Preamble
+
+ The licenses for most software are designed to take away your
+freedom to share and change it. By contrast, the GNU General Public
+Licenses are intended to guarantee your freedom to share and change
+free software--to make sure the software is free for all its users.
+
+ This license, the Lesser General Public License, applies to some
+specially designated software packages--typically libraries--of the
+Free Software Foundation and other authors who decide to use it. You
+can use it too, but we suggest you first think carefully about whether
+this license or the ordinary General Public License is the better
+strategy to use in any particular case, based on the explanations below.
+
+ When we speak of free software, we are referring to freedom of use,
+not price. Our General Public Licenses are designed to make sure that
+you have the freedom to distribute copies of free software (and charge
+for this service if you wish); that you receive source code or can get
+it if you want it; that you can change the software and use pieces of
+it in new free programs; and that you are informed that you can do
+these things.
+
+ To protect your rights, we need to make restrictions that forbid
+distributors to deny you these rights or to ask you to surrender these
+rights. These restrictions translate to certain responsibilities for
+you if you distribute copies of the library or if you modify it.
+
+ For example, if you distribute copies of the library, whether gratis
+or for a fee, you must give the recipients all the rights that we gave
+you. You must make sure that they, too, receive or can get the source
+code. If you link other code with the library, you must provide
+complete object files to the recipients, so that they can relink them
+with the library after making changes to the library and recompiling
+it. And you must show them these terms so they know their rights.
+
+ We protect your rights with a two-step method: (1) we copyright the
+library, and (2) we offer you this license, which gives you legal
+permission to copy, distribute and/or modify the library.
+
+ To protect each distributor, we want to make it very clear that
+there is no warranty for the free library. Also, if the library is
+modified by someone else and passed on, the recipients should know
+that what they have is not the original version, so that the original
+author's reputation will not be affected by problems that might be
+introduced by others.
+
+ Finally, software patents pose a constant threat to the existence of
+any free program. We wish to make sure that a company cannot
+effectively restrict the users of a free program by obtaining a
+restrictive license from a patent holder. Therefore, we insist that
+any patent license obtained for a version of the library must be
+consistent with the full freedom of use specified in this license.
+
+ Most GNU software, including some libraries, is covered by the
+ordinary GNU General Public License. This license, the GNU Lesser
+General Public License, applies to certain designated libraries, and
+is quite different from the ordinary General Public License. We use
+this license for certain libraries in order to permit linking those
+libraries into non-free programs.
+
+ When a program is linked with a library, whether statically or using
+a shared library, the combination of the two is legally speaking a
+combined work, a derivative of the original library. The ordinary
+General Public License therefore permits such linking only if the
+entire combination fits its criteria of freedom. The Lesser General
+Public License permits more lax criteria for linking other code with
+the library.
+
+ We call this license the "Lesser" General Public License because it
+does Less to protect the user's freedom than the ordinary General
+Public License. It also provides other free software developers Less
+of an advantage over competing non-free programs. These disadvantages
+are the reason we use the ordinary General Public License for many
+libraries. However, the Lesser license provides advantages in certain
+special circumstances.
+
+ For example, on rare occasions, there may be a special need to
+encourage the widest possible use of a certain library, so that it becomes
+a de-facto standard. To achieve this, non-free programs must be
+allowed to use the library. A more frequent case is that a free
+library does the same job as widely used non-free libraries. In this
+case, there is little to gain by limiting the free library to free
+software only, so we use the Lesser General Public License.
+
+ In other cases, permission to use a particular library in non-free
+programs enables a greater number of people to use a large body of
+free software. For example, permission to use the GNU C Library in
+non-free programs enables many more people to use the whole GNU
+operating system, as well as its variant, the GNU/Linux operating
+system.
+
+ Although the Lesser General Public License is Less protective of the
+users' freedom, it does ensure that the user of a program that is
+linked with the Library has the freedom and the wherewithal to run
+that program using a modified version of the Library.
+
+ The precise terms and conditions for copying, distribution and
+modification follow. Pay close attention to the difference between a
+"work based on the library" and a "work that uses the library". The
+former contains code derived from the library, whereas the latter must
+be combined with the library in order to run.
+
+ GNU LESSER GENERAL PUBLIC LICENSE
+ TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+
+ 0. This License Agreement applies to any software library or other
+program which contains a notice placed by the copyright holder or
+other authorized party saying it may be distributed under the terms of
+this Lesser General Public License (also called "this License").
+Each licensee is addressed as "you".
+
+ A "library" means a collection of software functions and/or data
+prepared so as to be conveniently linked with application programs
+(which use some of those functions and data) to form executables.
+
+ The "Library", below, refers to any such software library or work
+which has been distributed under these terms. A "work based on the
+Library" means either the Library or any derivative work under
+copyright law: that is to say, a work containing the Library or a
+portion of it, either verbatim or with modifications and/or translated
+straightforwardly into another language. (Hereinafter, translation is
+included without limitation in the term "modification".)
+
+ "Source code" for a work means the preferred form of the work for
+making modifications to it. For a library, complete source code means
+all the source code for all modules it contains, plus any associated
+interface definition files, plus the scripts used to control compilation
+and installation of the library.
+
+ Activities other than copying, distribution and modification are not
+covered by this License; they are outside its scope. The act of
+running a program using the Library is not restricted, and output from
+such a program is covered only if its contents constitute a work based
+on the Library (independent of the use of the Library in a tool for
+writing it). Whether that is true depends on what the Library does
+and what the program that uses the Library does.
+
+ 1. You may copy and distribute verbatim copies of the Library's
+complete source code as you receive it, in any medium, provided that
+you conspicuously and appropriately publish on each copy an
+appropriate copyright notice and disclaimer of warranty; keep intact
+all the notices that refer to this License and to the absence of any
+warranty; and distribute a copy of this License along with the
+Library.
+
+ You may charge a fee for the physical act of transferring a copy,
+and you may at your option offer warranty protection in exchange for a
+fee.
+
+ 2. You may modify your copy or copies of the Library or any portion
+of it, thus forming a work based on the Library, and copy and
+distribute such modifications or work under the terms of Section 1
+above, provided that you also meet all of these conditions:
+
+ a) The modified work must itself be a software library.
+
+ b) You must cause the files modified to carry prominent notices
+ stating that you changed the files and the date of any change.
+
+ c) You must cause the whole of the work to be licensed at no
+ charge to all third parties under the terms of this License.
+
+ d) If a facility in the modified Library refers to a function or a
+ table of data to be supplied by an application program that uses
+ the facility, other than as an argument passed when the facility
+ is invoked, then you must make a good faith effort to ensure that,
+ in the event an application does not supply such function or
+ table, the facility still operates, and performs whatever part of
+ its purpose remains meaningful.
+
+ (For example, a function in a library to compute square roots has
+ a purpose that is entirely well-defined independent of the
+ application. Therefore, Subsection 2d requires that any
+ application-supplied function or table used by this function must
+ be optional: if the application does not supply it, the square
+ root function must still compute square roots.)
+
+These requirements apply to the modified work as a whole. If
+identifiable sections of that work are not derived from the Library,
+and can be reasonably considered independent and separate works in
+themselves, then this License, and its terms, do not apply to those
+sections when you distribute them as separate works. But when you
+distribute the same sections as part of a whole which is a work based
+on the Library, the distribution of the whole must be on the terms of
+this License, whose permissions for other licensees extend to the
+entire whole, and thus to each and every part regardless of who wrote
+it.
+
+Thus, it is not the intent of this section to claim rights or contest
+your rights to work written entirely by you; rather, the intent is to
+exercise the right to control the distribution of derivative or
+collective works based on the Library.
+
+In addition, mere aggregation of another work not based on the Library
+with the Library (or with a work based on the Library) on a volume of
+a storage or distribution medium does not bring the other work under
+the scope of this License.
+
+ 3. You may opt to apply the terms of the ordinary GNU General Public
+License instead of this License to a given copy of the Library. To do
+this, you must alter all the notices that refer to this License, so
+that they refer to the ordinary GNU General Public License, version 2,
+instead of to this License. (If a newer version than version 2 of the
+ordinary GNU General Public License has appeared, then you can specify
+that version instead if you wish.) Do not make any other change in
+these notices.
+
+ Once this change is made in a given copy, it is irreversible for
+that copy, so the ordinary GNU General Public License applies to all
+subsequent copies and derivative works made from that copy.
+
+ This option is useful when you wish to copy part of the code of
+the Library into a program that is not a library.
+
+ 4. You may copy and distribute the Library (or a portion or
+derivative of it, under Section 2) in object code or executable form
+under the terms of Sections 1 and 2 above provided that you accompany
+it with the complete corresponding machine-readable source code, which
+must be distributed under the terms of Sections 1 and 2 above on a
+medium customarily used for software interchange.
+
+ If distribution of object code is made by offering access to copy
+from a designated place, then offering equivalent access to copy the
+source code from the same place satisfies the requirement to
+distribute the source code, even though third parties are not
+compelled to copy the source along with the object code.
+
+ 5. A program that contains no derivative of any portion of the
+Library, but is designed to work with the Library by being compiled or
+linked with it, is called a "work that uses the Library". Such a
+work, in isolation, is not a derivative work of the Library, and
+therefore falls outside the scope of this License.
+
+ However, linking a "work that uses the Library" with the Library
+creates an executable that is a derivative of the Library (because it
+contains portions of the Library), rather than a "work that uses the
+library". The executable is therefore covered by this License.
+Section 6 states terms for distribution of such executables.
+
+ When a "work that uses the Library" uses material from a header file
+that is part of the Library, the object code for the work may be a
+derivative work of the Library even though the source code is not.
+Whether this is true is especially significant if the work can be
+linked without the Library, or if the work is itself a library. The
+threshold for this to be true is not precisely defined by law.
+
+ If such an object file uses only numerical parameters, data
+structure layouts and accessors, and small macros and small inline
+functions (ten lines or less in length), then the use of the object
+file is unrestricted, regardless of whether it is legally a derivative
+work. (Executables containing this object code plus portions of the
+Library will still fall under Section 6.)
+
+ Otherwise, if the work is a derivative of the Library, you may
+distribute the object code for the work under the terms of Section 6.
+Any executables containing that work also fall under Section 6,
+whether or not they are linked directly with the Library itself.
+
+ 6. As an exception to the Sections above, you may also combine or
+link a "work that uses the Library" with the Library to produce a
+work containing portions of the Library, and distribute that work
+under terms of your choice, provided that the terms permit
+modification of the work for the customer's own use and reverse
+engineering for debugging such modifications.
+
+ You must give prominent notice with each copy of the work that the
+Library is used in it and that the Library and its use are covered by
+this License. You must supply a copy of this License. If the work
+during execution displays copyright notices, you must include the
+copyright notice for the Library among them, as well as a reference
+directing the user to the copy of this License. Also, you must do one
+of these things:
+
+ a) Accompany the work with the complete corresponding
+ machine-readable source code for the Library including whatever
+ changes were used in the work (which must be distributed under
+ Sections 1 and 2 above); and, if the work is an executable linked
+ with the Library, with the complete machine-readable "work that
+ uses the Library", as object code and/or source code, so that the
+ user can modify the Library and then relink to produce a modified
+ executable containing the modified Library. (It is understood
+ that the user who changes the contents of definitions files in the
+ Library will not necessarily be able to recompile the application
+ to use the modified definitions.)
+
+ b) Use a suitable shared library mechanism for linking with the
+ Library. A suitable mechanism is one that (1) uses at run time a
+ copy of the library already present on the user's computer system,
+ rather than copying library functions into the executable, and (2)
+ will operate properly with a modified version of the library, if
+ the user installs one, as long as the modified version is
+ interface-compatible with the version that the work was made with.
+
+ c) Accompany the work with a written offer, valid for at
+ least three years, to give the same user the materials
+ specified in Subsection 6a, above, for a charge no more
+ than the cost of performing this distribution.
+
+ d) If distribution of the work is made by offering access to copy
+ from a designated place, offer equivalent access to copy the above
+ specified materials from the same place.
+
+ e) Verify that the user has already received a copy of these
+ materials or that you have already sent this user a copy.
+
+ For an executable, the required form of the "work that uses the
+Library" must include any data and utility programs needed for
+reproducing the executable from it. However, as a special exception,
+the materials to be distributed need not include anything that is
+normally distributed (in either source or binary form) with the major
+components (compiler, kernel, and so on) of the operating system on
+which the executable runs, unless that component itself accompanies
+the executable.
+
+ It may happen that this requirement contradicts the license
+restrictions of other proprietary libraries that do not normally
+accompany the operating system. Such a contradiction means you cannot
+use both them and the Library together in an executable that you
+distribute.
+
+ 7. You may place library facilities that are a work based on the
+Library side-by-side in a single library together with other library
+facilities not covered by this License, and distribute such a combined
+library, provided that the separate distribution of the work based on
+the Library and of the other library facilities is otherwise
+permitted, and provided that you do these two things:
+
+ a) Accompany the combined library with a copy of the same work
+ based on the Library, uncombined with any other library
+ facilities. This must be distributed under the terms of the
+ Sections above.
+
+ b) Give prominent notice with the combined library of the fact
+ that part of it is a work based on the Library, and explaining
+ where to find the accompanying uncombined form of the same work.
+
+ 8. You may not copy, modify, sublicense, link with, or distribute
+the Library except as expressly provided under this License. Any
+attempt otherwise to copy, modify, sublicense, link with, or
+distribute the Library is void, and will automatically terminate your
+rights under this License. However, parties who have received copies,
+or rights, from you under this License will not have their licenses
+terminated so long as such parties remain in full compliance.
+
+ 9. You are not required to accept this License, since you have not
+signed it. However, nothing else grants you permission to modify or
+distribute the Library or its derivative works. These actions are
+prohibited by law if you do not accept this License. Therefore, by
+modifying or distributing the Library (or any work based on the
+Library), you indicate your acceptance of this License to do so, and
+all its terms and conditions for copying, distributing or modifying
+the Library or works based on it.
+
+ 10. Each time you redistribute the Library (or any work based on the
+Library), the recipient automatically receives a license from the
+original licensor to copy, distribute, link with or modify the Library
+subject to these terms and conditions. You may not impose any further
+restrictions on the recipients' exercise of the rights granted herein.
+You are not responsible for enforcing compliance by third parties with
+this License.
+
+ 11. If, as a consequence of a court judgment or allegation of patent
+infringement or for any other reason (not limited to patent issues),
+conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License. If you cannot
+distribute so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you
+may not distribute the Library at all. For example, if a patent
+license would not permit royalty-free redistribution of the Library by
+all those who receive copies directly or indirectly through you, then
+the only way you could satisfy both it and this License would be to
+refrain entirely from distribution of the Library.
+
+If any portion of this section is held invalid or unenforceable under any
+particular circumstance, the balance of the section is intended to apply,
+and the section as a whole is intended to apply in other circumstances.
+
+It is not the purpose of this section to induce you to infringe any
+patents or other property right claims or to contest validity of any
+such claims; this section has the sole purpose of protecting the
+integrity of the free software distribution system which is
+implemented by public license practices. Many people have made
+generous contributions to the wide range of software distributed
+through that system in reliance on consistent application of that
+system; it is up to the author/donor to decide if he or she is willing
+to distribute software through any other system and a licensee cannot
+impose that choice.
+
+This section is intended to make thoroughly clear what is believed to
+be a consequence of the rest of this License.
+
+ 12. If the distribution and/or use of the Library is restricted in
+certain countries either by patents or by copyrighted interfaces, the
+original copyright holder who places the Library under this License may add
+an explicit geographical distribution limitation excluding those countries,
+so that distribution is permitted only in or among countries not thus
+excluded. In such case, this License incorporates the limitation as if
+written in the body of this License.
+
+ 13. The Free Software Foundation may publish revised and/or new
+versions of the Lesser General Public License from time to time.
+Such new versions will be similar in spirit to the present version,
+but may differ in detail to address new problems or concerns.
+
+Each version is given a distinguishing version number. If the Library
+specifies a version number of this License which applies to it and
+"any later version", you have the option of following the terms and
+conditions either of that version or of any later version published by
+the Free Software Foundation. If the Library does not specify a
+license version number, you may choose any version ever published by
+the Free Software Foundation.
+
+ 14. If you wish to incorporate parts of the Library into other free
+programs whose distribution conditions are incompatible with these,
+write to the author to ask for permission. For software which is
+copyrighted by the Free Software Foundation, write to the Free
+Software Foundation; we sometimes make exceptions for this. Our
+decision will be guided by the two goals of preserving the free status
+of all derivatives of our free software and of promoting the sharing
+and reuse of software generally.
+
+ NO WARRANTY
+
+ 15. BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO
+WARRANTY FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW.
+EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR
+OTHER PARTIES PROVIDE THE LIBRARY "AS IS" WITHOUT WARRANTY OF ANY
+KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE
+LIBRARY IS WITH YOU. SHOULD THE LIBRARY PROVE DEFECTIVE, YOU ASSUME
+THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
+
+ 16. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN
+WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY
+AND/OR REDISTRIBUTE THE LIBRARY AS PERMITTED ABOVE, BE LIABLE TO YOU
+FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR
+CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE
+LIBRARY (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING
+RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A
+FAILURE OF THE LIBRARY TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF
+SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
+DAMAGES.
+
+ END OF TERMS AND CONDITIONS
+
+ How to Apply These Terms to Your New Libraries
+
+ If you develop a new library, and you want it to be of the greatest
+possible use to the public, we recommend making it free software that
+everyone can redistribute and change. You can do so by permitting
+redistribution under these terms (or, alternatively, under the terms of the
+ordinary General Public License).
+
+ To apply these terms, attach the following notices to the library. It is
+safest to attach them to the start of each source file to most effectively
+convey the exclusion of warranty; and each file should have at least the
+"copyright" line and a pointer to where the full notice is found.
+
+ <one line to give the library's name and a brief idea of what it does.>
+ Copyright (C) <year> <name of author>
+
+ This library is free software; you can redistribute it and/or
+ modify it under the terms of the GNU Lesser General Public
+ License as published by the Free Software Foundation; either
+ version 2.1 of the License, or (at your option) any later version.
+
+ This library is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ Lesser General Public License for more details.
+
+ You should have received a copy of the GNU Lesser General Public
+ License along with this library; if not, write to the Free Software
+ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301
USA
+
+Also add information on how to contact you by electronic and paper mail.
+
+You should also get your employer (if you work as a programmer) or your
+school, if any, to sign a "copyright disclaimer" for the library, if
+necessary. Here is a sample; alter the names:
+
+ Yoyodyne, Inc., hereby disclaims all copyright interest in the
+ library `Frob' (a library for tweaking knobs) written by James Random Hacker.
+
+ <signature of Ty Coon>, 1 April 1990
+ Ty Coon, President of Vice
+
+That's all there is to it!
diff --git a/lib/python/MANIFEST.in b/lib/python/MANIFEST.in
new file mode 100644
index 0000000..1aba38f
--- /dev/null
+++ b/lib/python/MANIFEST.in
@@ -0,0 +1 @@
+include LICENSE
diff --git a/lib/python/README.rst b/lib/python/README.rst
new file mode 100644
index 0000000..5721a7d
--- /dev/null
+++ b/lib/python/README.rst
@@ -0,0 +1,58 @@
+GNU SASL Python Bindings
+========================
+
+The `GNU SASL library <http://www.gnu.org/software/gsasl>`_ is a portable
+implementation of the Simple Authentication and Security Layer framework and a
+few common SASL mechanisms. This module provides a Pythonic interface to the
+GNU SASL library to access its functionality in Python applications.
+
+Requirements
+------------
+
+The GNU SASL Python interface should work on any platform supported by GNU SASL
+itself with Python 2.6 or later, including Python 3. It requires a valid
+libgsasl installation before the module can be imported.
+
+If a GNU SASL shared library file is not found by the module, its directory can
+be specified with the environment variable ``LD_LIBRARY_PATH`` on GNU/Linux or
+GNU Hurd distributions, ``DYLD_LIBRARY_PATH`` on Mac OS X, and ``PATH`` on
+Windows.
+
+The following platforms have commands to install libgsasl globally.
+
+Debian
+ ``apt-get install libgsasl7``
+
+Fedora
+ ``dnf install libgsasl``
+
+CentOS, RHEL (`EPEL <http://fedoraproject.org/wiki/EPEL>`_)
+ ``yum install libgsasl``
+
+Mac OS X (`Homebrew <http://brew.sh>`_)
+ ``brew install gsasl``
+
+Example
+-------
+
+A GSSAPI client can be started quickly like this:
+
+.. code:: python
+
+ from gsasl import Gsasl, GsaslError
+
+ try:
+ client = Gsasl().client_start('GSSAPI')
+ except GsaslError:
+ raise # Handle potential mechanism support problems.
+
+ client.property_set_bulk(
+ authzid='username',
+ hostname='server.example.com',
+ service='service',
+ )
+
+ try:
+ base64_creds, finished = client.step64()
+ except GsaslError:
+ raise # Handle potential client property problems.
diff --git a/lib/python/gsasl/__init__.py b/lib/python/gsasl/__init__.py
new file mode 100644
index 0000000..39d0c0f
--- /dev/null
+++ b/lib/python/gsasl/__init__.py
@@ -0,0 +1,411 @@
+"""Pythonic interface to the gsasl library
+
+The module provides the following public classes:
+
+Gsasl(object) -- Initializes a libgsasl context and operates on it
+GsaslSession(object) -- Stores a session context and operates on it
+GsaslClient(GsaslSession) -- Initializes a client session context
+GsaslServer(GsaslSession) -- Initializes a server session context
+GsaslError(Exception) -- Raised when libgsasl functions return errors
+
+The module provides the following public functions:
+
+check_version -- Tests if the library is at least as new as requested
+saslprep -- Prepare a string (stringprep) with the SASLprep profile
+
+The module provides the following submodule:
+
+enum -- Exports dictionaries of named numerical constants
+
+Most of libgsasl's functionality is available through the above classes
+and functions, but the following library functions were omitted:
+
+ * gsasl_base64_from, gsasl_base64_to
+ Use the base64 module for this functionality.
+
+ * gsasl_hmac_md5, gsasl_hmac_sha1, gsasl_md5, gsasl_sha1
+ Use the hashlib and hmac modules for this functionality.
+
+ * gsasl_nonce, gsasl_random
+ Use the random module for this functionality.
+
+ * gsasl_simple_getpass
+ Use "if line.startswith(username + '\t')" in a file loop.
+
+ * gsasl_callback, gsasl_callback_set,
+ gsasl_callback_hook_get, gsasl_callback_hook_set,
+ gsasl_session_hook_get, gsasl_session_hook_set
+ Application callbacks are not implemented yet.
+
+The module provides the following functions that are not used in normal
+operation, but they can access the unexported libgsasl functions:
+
+get_library_handle -- Returns a CDLL object for libgsasl
+pythonize_memory -- Converts a C memory pointer to a Python string
+"""
+
+from ctypes import CDLL, byref, c_char_p, c_int, create_string_buffer, memmove
+from ctypes.util import find_library
+
+from gsasl import enum
+
+
+# Utility Functions
+
+def _b2s(data):
+ """Convert bytes to str for Python 3 ctypes compatibility."""
+ if data is not None and not isinstance(data, str):
+ return data.decode('utf-8')
+ return data
+
+
+def _s2b(string):
+ """Convert str to bytes for Python 3 ctypes compatibility."""
+ if string is not None and not isinstance(string, bytes):
+ return string.encode('utf-8')
+ return string
+
+
+def _s2p(string):
+ """Convert str to c_char_p for compatibility and convenience."""
+ if string is not None and not isinstance(string, bytes):
+ return c_char_p(string.encode('utf-8'))
+ return c_char_p(string)
+
+
+def get_library_handle():
+ """Return a CDLL object providing the raw interface to libgsasl.
+
+ Many of the library functions' return types are also specified here
+ before returning the CDLL object. They are configured to either
+ raise an exception on non-zero return codes or to return a string
+ instead of constant character pointers.
+ """
+ def cb_errcheck_ok(result, func, arguments):
+ """Raise a GsaslError on non-zero return codes from libgsasl."""
+ if result != enum.rc.OK:
+ raise GsaslError(result)
+ return result
+
+ # Get a libgsasl handle, either a UNIX SO or a Windows DLL.
+ name = find_library('gsasl') or find_library('libgsasl-7') or 'libgsasl.so'
+ libgsasl = CDLL(name)
+
+ # Prepare functions that should always return GSASL_OK.
+ libgsasl.gsasl_base64_from.errcheck = cb_errcheck_ok
+ libgsasl.gsasl_base64_to.errcheck = cb_errcheck_ok
+ libgsasl.gsasl_client_mechlist.errcheck = cb_errcheck_ok
+ libgsasl.gsasl_client_start.errcheck = cb_errcheck_ok
+ libgsasl.gsasl_decode.errcheck = cb_errcheck_ok
+ libgsasl.gsasl_encode.errcheck = cb_errcheck_ok
+ libgsasl.gsasl_hmac_md5.errcheck = cb_errcheck_ok
+ libgsasl.gsasl_hmac_sha1.errcheck = cb_errcheck_ok
+ libgsasl.gsasl_init.errcheck = cb_errcheck_ok
+ libgsasl.gsasl_md5.errcheck = cb_errcheck_ok
+ libgsasl.gsasl_nonce.errcheck = cb_errcheck_ok
+ libgsasl.gsasl_random.errcheck = cb_errcheck_ok
+ libgsasl.gsasl_saslprep.errcheck = cb_errcheck_ok
+ libgsasl.gsasl_server_mechlist.errcheck = cb_errcheck_ok
+ libgsasl.gsasl_server_start.errcheck = cb_errcheck_ok
+ libgsasl.gsasl_sha1.errcheck = cb_errcheck_ok
+ libgsasl.gsasl_simple_getpass.errcheck = cb_errcheck_ok
+
+ # Prepare functions that return an internally managed string.
+ libgsasl.gsasl_check_version.restype = c_char_p
+ libgsasl.gsasl_client_suggest_mechanism.restype = c_char_p
+ libgsasl.gsasl_mechanism_name.restype = c_char_p
+ libgsasl.gsasl_property_fast.restype = c_char_p
+ libgsasl.gsasl_property_get.restype = c_char_p
+ libgsasl.gsasl_strerror.restype = c_char_p
+ libgsasl.gsasl_strerror_name.restype = c_char_p
+
+ return libgsasl
+
+
+def pythonize_memory(pointer, length=None):
+ """Convert data at a pointer to a Python string and free its memory.
+
+ For binary data, this method should be given a c_char_p pointing at
+ the data and its length in bytes as arguments.
+
+ For plain (NUL-terminated) text, the length argument can be omitted.
+ """
+ if pointer is None or pointer.value is None:
+ return None
+ if length is None:
+ length = len(pointer.value) # Don't copy the trailing NUL for text.
+ string_buffer = create_string_buffer(length)
+ memmove(string_buffer, pointer, length)
+ _lib.gsasl_free(pointer)
+ return string_buffer.raw
+
+
+# Pythonic Library Interface
+
+class GsaslError(Exception):
+ """Create an exception using error codes from libgsasl functions."""
+
+ def __init__(self, err):
+ """Initialize an error message generated from a return code.
+
+ The specific error code is saved as the "err" attribute, which
+ can be used in "except" blocks to handle known problems.
+ """
+ self.err = err
+ message = _b2s(_lib.gsasl_strerror(err))
+ name = _b2s(_lib.gsasl_strerror_name(err))
+ if name is not None:
+ message = '%s: %s' % (name, message)
+ super(GsaslError, self).__init__(message)
+
+
+class GsaslSession(object):
+ """Create an object that stores and operates on a session context.
+
+ This class should not be initialized directly. Instead, see the
+ GsaslClient and GsaslServer subclasses which provide the session
+ context. Any users that don't care about client vs server contexts
+ can do type checking with this class, while others can test with
+ GsaslClient and GsaslServer.
+ """
+
+ def __init__(self, gsasl, sctx):
+ """Initialize a session object by storing a context pointer.
+
+ The session context itself should be initialized by the calling
+ function. That allows this class to remain unaware of the type
+ of session it's using.
+
+ A reference to the Gsasl object that initialized the session
+ context is also stored here so that it does not fall victim to
+ garbage collection while the session is still active.
+ """
+ self.gsasl = gsasl
+ self.sctx = sctx
+
+ def __del__(self):
+ """Destroy the session context."""
+ _lib.gsasl_finish(self.sctx)
+
+ @property
+ def mechanism_name(self):
+ """Return the name of the mechanism used by this session."""
+ return _b2s(_lib.gsasl_mechanism_name(self.sctx))
+
+ def decode(self, data):
+ """Decode the given data using the session's parameters.
+
+ The returned value is a byte string to support binary data.
+ """
+ input_bytes = _s2b(data)
+ input_len = 0 if input_bytes is None else len(input_bytes)
+ output = c_char_p()
+ output_len = c_int(0)
+ _lib.gsasl_decode(self.sctx,
+ c_char_p(input_bytes), input_len,
+ byref(output), byref(output_len))
+ return pythonize_memory(output, output_len.value)
+
+ def encode(self, data):
+ """Encode the given data using the session's parameters.
+
+ The returned value is a byte string to support binary data.
+ """
+ input_bytes = _s2b(data)
+ input_len = 0 if input_bytes is None else len(input_bytes)
+ output = c_char_p()
+ output_len = c_int(0)
+ _lib.gsasl_encode(self.sctx,
+ c_char_p(input_bytes), input_len,
+ byref(output), byref(output_len))
+ return pythonize_memory(output, output_len.value)
+
+ def property_fast(self, prop):
+ """Return the value of the given property, skipping callbacks.
+
+ If the given property is not a numerical value, assume it is a
+ key to look up the numerical value in enum.property.
+
+ The returned data is a byte string to support binary data.
+ """
+ if not isinstance(prop, int):
+ prop = enum.property[prop.upper()]
+ return _lib.gsasl_property_fast(self.sctx, prop)
+
+ def property_get(self, prop):
+ """Return the value of the given property.
+
+ If the given property is not a numerical value, assume it is a
+ key to look up the numerical value in enum.property.
+
+ The returned data is a byte string to support binary data.
+ """
+ if not isinstance(prop, int):
+ prop = enum.property[prop.upper()]
+ return _lib.gsasl_property_get(self.sctx, prop)
+
+ def property_set(self, prop, data):
+ """Store the given data as the value of the given property.
+
+ If the given property is not a numerical value, assume it is a
+ key to look up the numerical value in enum.property.
+
+ The actual library function used here is gsasl_property_set_raw
+ so that binary data in a Python string can be stored correctly.
+ """
+ if not isinstance(prop, int):
+ prop = enum.property[prop.upper()]
+ bdata = _s2b(data)
+ length = 0 if bdata is None else len(bdata)
+ _lib.gsasl_property_set_raw(self.sctx, prop, c_char_p(bdata), length)
+
+ def property_set_bulk(self, **kwargs):
+ """Given "key=value" arguments, set property "key" to "value".
+
+ For readability, property keys will be converted to uppercase.
+ """
+ for key, value in kwargs.items():
+ self.property_set(key, value)
+
+ def step(self, data=None):
+ """Return a step of SASL authentication output.
+
+ A tuple of the output data and a boolean are returned. The
+ output data will be a byte string since it can be binary. The
+ boolean will be True if authentication ended successfully, or it
+ will be False if more data is required.
+ """
+ input_bytes = _s2b(data)
+ input_len = 0 if input_bytes is None else len(input_bytes)
+ output = c_char_p()
+ output_len = c_int(0)
+ err = _lib.gsasl_step(self.sctx,
+ c_char_p(input_bytes), input_len,
+ byref(output), byref(output_len))
+ if err not in (enum.rc.OK, enum.rc.NEEDS_MORE):
+ raise GsaslError(err)
+ return pythonize_memory(output, output_len.value), err == enum.rc.OK
+
+ def step64(self, data=None):
+ """Given base64-encoded input, return encoded step output.
+
+ A tuple of the output data and a boolean are returned. The
+ output data will be a string of the base64-encoded results. The
+ boolean will be True if authentication ended successfully, or it
+ will be False if more data is required.
+ """
+ output = c_char_p()
+ err = _lib.gsasl_step64(self.sctx, _s2p(data), byref(output))
+ if err not in (enum.rc.OK, enum.rc.NEEDS_MORE):
+ raise GsaslError(err)
+ return _b2s(pythonize_memory(output)), err == enum.rc.OK
+
+
+class GsaslClient(GsaslSession):
+ """Create a GsaslSession with a client session context."""
+
+ def __init__(self, gsasl, mechanism):
+ """Initialize a new client context using the given mechanism."""
+ super(GsaslClient, self).__init__(gsasl, c_char_p())
+ _lib.gsasl_client_start(gsasl.ctx, _s2p(mechanism), byref(self.sctx))
+
+
+class GsaslServer(GsaslSession):
+ """Create a GsaslSession with a server session context."""
+
+ def __init__(self, gsasl, mechanism):
+ """Initialize a new server context using the given mechanism."""
+ super(GsaslServer, self).__init__(gsasl, c_char_p())
+ _lib.gsasl_server_start(gsasl.ctx, _s2p(mechanism), byref(self.sctx))
+
+
+class Gsasl(object):
+ """Create and operate on a libgsasl library context.
+
+ Instances of this class can be used to determine supported mechanism
+ names and spawn client and server sessions.
+ """
+
+ def __init__(self):
+ """Initialize and save a new library context pointer."""
+ self.ctx = c_char_p()
+ _lib.gsasl_init(byref(self.ctx))
+
+ def __del__(self):
+ """Destroy the library context."""
+ _lib.gsasl_done(self.ctx)
+
+ @property
+ def client_mechlist(self):
+ """Return a list of mechanisms available to client sessions."""
+ output = c_char_p()
+ _lib.gsasl_client_mechlist(self.ctx, byref(output))
+ return _b2s(pythonize_memory(output)).split()
+
+ @property
+ def server_mechlist(self):
+ """Return a list of mechanisms available to server sessions."""
+ output = c_char_p()
+ _lib.gsasl_server_mechlist(self.ctx, byref(output))
+ return _b2s(pythonize_memory(output)).split()
+
+ def client_suggest_mechanism(self, mechs=None):
+ """Return a suggested mechanism name that the client supports.
+
+ If a list (or space-separated string) of mechanism names is
+ given as an argument, the name returned will be a name that is
+ both in the list and supported by the client, or None if no such
+ mechanism exists.
+ """
+ if mechs is None:
+ mechs = self.client_mechlist
+ if hasattr(mechs, '__iter__') and not isinstance(mechs, (str, bytes)):
+ mechs = ' '.join(mechs)
+ return _b2s(_lib.gsasl_client_suggest_mechanism(self.ctx, _s2p(mechs)))
+
+ def client_start(self, mechanism):
+ """Return a new client session using the given mechanism."""
+ return GsaslClient(self, mechanism)
+
+ def client_support(self, mechanism):
+ """Return whether the client supports the given mechanism."""
+ return _lib.gsasl_client_support_p(self.ctx, _s2p(mechanism)) != 0
+
+ def server_start(self, mechanism):
+ """Return a new server session using the given mechanism."""
+ return GsaslServer(self, mechanism)
+
+ def server_support(self, mechanism):
+ """Return whether the server supports the given mechanism."""
+ return _lib.gsasl_server_support_p(self.ctx, _s2p(mechanism)) != 0
+
+
+def check_version(version=None):
+ """Test the libgsasl version against the given version number.
+
+ Return the library version if it is at least as new as the given
+ value, or return None otherwise. If the version argument is None,
+ the library version is always returned.
+ """
+ return _b2s(_lib.gsasl_check_version(_s2p(version)))
+
+
+def saslprep(string, flags=0, **kwargs):
+ """Run the given string through the stringprep's SASLprep profile.
+
+ Values from enum.saslprep_flags can be passed as the flags argument.
+ Alternatively, names from enum.saslprep_flags can be supplied like
+ "name=True" or "name=False" to set or unset the flags, respectively.
+ """
+ if string is None:
+ return None # Avoid passing NULL, otherwise saslprep segfaults.
+ for key, value in kwargs.items():
+ flag = enum.saslprep_flags[key.upper()]
+ flags = flags | flag if value else flags & ~flag
+ output = c_char_p()
+ prep_rc = c_int(0) # This is currently unused after being set.
+ _lib.gsasl_saslprep(_s2p(string), flags, byref(output), byref(prep_rc))
+ return _b2s(pythonize_memory(output))
+
+
+_lib = get_library_handle()
diff --git a/lib/python/gsasl/enum.py b/lib/python/gsasl/enum.py
new file mode 100644
index 0000000..7726a5e
--- /dev/null
+++ b/lib/python/gsasl/enum.py
@@ -0,0 +1,132 @@
+"""Named numerical constants used by the gsasl library
+
+The module provides the following public class, which should not need to
+be accessed directly in normal operation:
+
+GsaslEnum(dict) -- Accesses dictionary items through attributes
+
+The following public dictionaries are instances of the above class:
+
+rc -- Return codes from libgsasl functions
+qop -- Quality of protection types for DIGEST-MD5 and GSSAPI
+cipher -- Encryption types for DIGEST-MD5
+saslprep_flags -- Modifiers for the saslprep function
+property -- Session property types
+"""
+
+
+class GsaslEnum(dict):
+ """Allow dictionary item access as attributes for code readability.
+
+ This permits Python code such as "if err == enum.rc.OK:" which has
+ enumeration expressions more recognizable as constants, but keeping
+ the values in dictionaries also preserves easy discoverability with
+ code such as "for property_name in enum.property:".
+
+ In other words, this is a rudimentary alternative to the Python 3
+ class enum.IntEnum for use with older versions of Python.
+ """
+
+ __getattr__ = dict.get
+
+
+rc = GsaslEnum({
+ 'OK': 0,
+ 'NEEDS_MORE': 1,
+ 'UNKNOWN_MECHANISM': 2,
+ 'MECHANISM_CALLED_TOO_MANY_TIMES': 3,
+ 'MALLOC_ERROR': 7,
+ 'BASE64_ERROR': 8,
+ 'CRYPTO_ERROR': 9,
+ 'SASLPREP_ERROR': 29,
+ 'MECHANISM_PARSE_ERROR': 30,
+ 'AUTHENTICATION_ERROR': 31,
+ 'INTEGRITY_ERROR': 33,
+ 'NO_CLIENT_CODE': 35,
+ 'NO_SERVER_CODE': 36,
+ 'NO_CALLBACK': 51,
+ 'NO_ANONYMOUS_TOKEN': 52,
+ 'NO_AUTHID': 53,
+ 'NO_AUTHZID': 54,
+ 'NO_PASSWORD': 55,
+ 'NO_PASSCODE': 56,
+ 'NO_PIN': 57,
+ 'NO_SERVICE': 58,
+ 'NO_HOSTNAME': 59,
+ 'NO_CB_TLS_UNIQUE': 65,
+ 'NO_SAML20_IDP_IDENTIFIER': 66,
+ 'NO_SAML20_REDIRECT_URL': 67,
+ 'NO_OPENID20_REDIRECT_URL': 68,
+ 'GSSAPI_RELEASE_BUFFER_ERROR': 37,
+ 'GSSAPI_IMPORT_NAME_ERROR': 38,
+ 'GSSAPI_INIT_SEC_CONTEXT_ERROR': 39,
+ 'GSSAPI_ACCEPT_SEC_CONTEXT_ERROR': 40,
+ 'GSSAPI_UNWRAP_ERROR': 41,
+ 'GSSAPI_WRAP_ERROR': 42,
+ 'GSSAPI_ACQUIRE_CRED_ERROR': 43,
+ 'GSSAPI_DISPLAY_NAME_ERROR': 44,
+ 'GSSAPI_UNSUPPORTED_PROTECTION_ERROR': 45,
+ 'KERBEROS_V5_INIT_ERROR': 46,
+ 'KERBEROS_V5_INTERNAL_ERROR': 47,
+ 'SHISHI_ERROR': 47,
+ 'SECURID_SERVER_NEED_ADDITIONAL_PASSCODE': 48,
+ 'SECURID_SERVER_NEED_NEW_PIN': 49,
+ 'GSSAPI_ENCAPSULATE_TOKEN_ERROR': 60,
+ 'GSSAPI_DECAPSULATE_TOKEN_ERROR': 61,
+ 'GSSAPI_INQUIRE_MECH_FOR_SASLNAME_ERROR': 62,
+ 'GSSAPI_TEST_OID_SET_MEMBER_ERROR': 63,
+ 'GSSAPI_RELEASE_OID_SET_ERROR': 64,
+})
+
+qop = GsaslEnum({
+ 'QOP_AUTH': 1,
+ 'QOP_AUTH_INT': 2,
+ 'QOP_AUTH_CONF': 4,
+})
+
+cipher = GsaslEnum({
+ 'CIPHER_DES': 1,
+ 'CIPHER_3DES': 2,
+ 'CIPHER_RC4': 4,
+ 'CIPHER_RC4_40': 8,
+ 'CIPHER_RC4_56': 16,
+ 'CIPHER_AES': 32,
+})
+
+saslprep_flags = GsaslEnum({
+ 'ALLOW_UNASSIGNED': 1,
+})
+
+property = GsaslEnum({
+ 'AUTHID': 1,
+ 'AUTHZID': 2,
+ 'PASSWORD': 3,
+ 'ANONYMOUS_TOKEN': 4,
+ 'SERVICE': 5,
+ 'HOSTNAME': 6,
+ 'GSSAPI_DISPLAY_NAME': 7,
+ 'PASSCODE': 8,
+ 'SUGGESTED_PIN': 9,
+ 'PIN': 10,
+ 'REALM': 11,
+ 'DIGEST_MD5_HASHED_PASSWORD': 12,
+ 'QOPS': 13,
+ 'QOP': 14,
+ 'SCRAM_ITER': 15,
+ 'SCRAM_SALT': 16,
+ 'SCRAM_SALTED_PASSWORD': 17,
+ 'CB_TLS_UNIQUE': 18,
+ 'SAML20_IDP_IDENTIFIER': 19,
+ 'SAML20_REDIRECT_URL': 20,
+ 'OPENID20_REDIRECT_URL': 21,
+ 'OPENID20_OUTCOME_DATA': 22,
+ 'SAML20_AUTHENTICATE_IN_BROWSER': 250,
+ 'OPENID20_AUTHENTICATE_IN_BROWSER': 251,
+ 'VALIDATE_SIMPLE': 500,
+ 'VALIDATE_EXTERNAL': 501,
+ 'VALIDATE_ANONYMOUS': 502,
+ 'VALIDATE_GSSAPI': 503,
+ 'VALIDATE_SECURID': 504,
+ 'VALIDATE_SAML20': 505,
+ 'VALIDATE_OPENID20': 506,
+})
diff --git a/lib/python/gsasl/tests.py b/lib/python/gsasl/tests.py
new file mode 100644
index 0000000..5807801
--- /dev/null
+++ b/lib/python/gsasl/tests.py
@@ -0,0 +1,200 @@
+"""Tests for the gsasl Python interface
+
+This file provides the following public classes:
+
+BaseGsaslTestCase(TestCase) -- Tests check_version and saslprep
+GsaslTestCase(TestCase) -- Tests Gsasl
+GsaslClientTestCase(TestCase) -- Tests GsaslClient
+GsaslServerTestCase(GsaslClientTestCase) -- Tests GsaslServer
+
+The tests defined by these classes are intended to verify only that the
+Python interface successfully returns correct data types and doesn't
+cause the interpreter to crash. It is expected that the actual libgsasl
+functionality and standards conformance have been tested separately.
+"""
+
+from unittest import TestCase, main
+
+from gsasl import Gsasl, GsaslError, GsaslClient, GsaslServer
+from gsasl import check_version, saslprep
+
+
+# Choose a supported mechanism name to test against.
+MECH = 'PLAIN'
+
+
+class BaseGsaslTestCase(TestCase):
+ """Test standalone functions."""
+
+ def test_check_version(self):
+ """Test passing older, newer, and no version strings."""
+ version = check_version()
+ self.assertIsInstance(version, str)
+ self.assertEqual(check_version('0'), version)
+ self.assertIsNone(check_version('999'))
+
+ def test_saslprep(self):
+ """Test that ASCII characters are unchanged.
+
+ Assume libidn was already tested for the real functionality used
+ here, since if gsasl was built without libidn, saslprep will
+ raise an error on a non-ASCII character.
+ """
+ self.assertEqual(saslprep('abc'), 'abc')
+ self.assertIsNone(saslprep(None))
+
+
+class GsaslTestCase(TestCase):
+ """Test functions that rely on an initialized library context."""
+
+ def setUp(self):
+ """Set up a library context."""
+ self.gsasl = Gsasl()
+
+ def tearDown(self):
+ """Destroy the library context."""
+ del self.gsasl
+
+ def test_client_mechlist(self):
+ """Test that the client has a list of mechanisms."""
+ mechlist = self.gsasl.client_mechlist
+ self.assertIsInstance(mechlist, list)
+ self.assertIn(MECH, mechlist)
+
+ def test_client_start(self):
+ """Test that a client can be started."""
+ client = self.gsasl.client_start(MECH)
+ self.assertIsInstance(client, GsaslClient)
+ self.assertEqual(client.gsasl, self.gsasl)
+ self.assertRaises(GsaslError, lambda: self.gsasl.client_start(None))
+ self.assertRaises(GsaslError, lambda: self.gsasl.client_start(''))
+
+ def test_client_suggest_mechanism(self):
+ """Test that mechanisms are suggested from lists and strings."""
+ self.assertIsInstance(self.gsasl.client_suggest_mechanism(), str)
+ self.assertEqual(self.gsasl.client_suggest_mechanism(['X', MECH]),
+ MECH)
+ self.assertEqual(self.gsasl.client_suggest_mechanism('X %s Y' % MECH),
+ MECH)
+ self.assertEqual(self.gsasl.client_suggest_mechanism(MECH), MECH)
+ self.assertIsNone(self.gsasl.client_suggest_mechanism(['X', 'Y', 'Z']))
+ self.assertIsNone(self.gsasl.client_suggest_mechanism('X Y Z'))
+ self.assertIsNone(self.gsasl.client_suggest_mechanism(' '))
+ self.assertIsNone(self.gsasl.client_suggest_mechanism(''))
+
+ def test_client_support(self):
+ """Test that the client supports a mechanism."""
+ self.assertTrue(self.gsasl.client_support(MECH))
+ self.assertFalse(self.gsasl.client_support(None))
+ self.assertFalse(self.gsasl.client_support('NONSENSE'))
+ self.assertFalse(self.gsasl.client_support(' '))
+ self.assertFalse(self.gsasl.client_support(''))
+
+ def test_server_mechlist(self):
+ """Test that the server has a list of mechanisms."""
+ mechlist = self.gsasl.client_mechlist
+ self.assertIsInstance(mechlist, list)
+ self.assertIn(MECH, mechlist)
+
+ def test_server_start(self):
+ """Test that a server can be started."""
+ server = self.gsasl.server_start(MECH)
+ self.assertIsInstance(server, GsaslServer)
+ self.assertEqual(server.gsasl, self.gsasl)
+ self.assertRaises(GsaslError, lambda: self.gsasl.server_start(None))
+ self.assertRaises(GsaslError, lambda: self.gsasl.server_start(''))
+
+ def test_server_support(self):
+ """Test that the server supports a mechanism."""
+ self.assertTrue(self.gsasl.server_support(MECH))
+ self.assertFalse(self.gsasl.server_support(None))
+ self.assertFalse(self.gsasl.server_support('NONSENSE'))
+ self.assertFalse(self.gsasl.server_support(' '))
+ self.assertFalse(self.gsasl.server_support(''))
+
+
+class GsaslClientTestCase(TestCase):
+ """Test functions that rely on an initialized client context."""
+
+ def setUp(self):
+ """Set up a client session context."""
+ self.session = Gsasl().client_start(MECH)
+
+ def tearDown(self):
+ """Destroy the session context."""
+ del self.session
+
+ def test_encode(self):
+ """Test PLAIN encoding."""
+ self.assertEqual(self.session.encode('text'), b'text')
+ self.assertEqual(self.session.encode(None), b'')
+
+ def test_decode(self):
+ """Test PLAIN decoding."""
+ self.assertEqual(self.session.decode('text'), b'text')
+ self.assertEqual(self.session.decode(None), b'')
+
+ def test_mechanism_name(self):
+ """Test that the mechanism name matches the constructor."""
+ self.assertEqual(self.session.mechanism_name, MECH)
+
+ def test_properties(self):
+ """Test setting and getting session properties."""
+ self.assertIsNone(self.session.property_fast('AUTHID'))
+ self.assertIsNone(self.session.property_get('AUTHID'))
+ self.session.property_set('AUTHID', 'user1')
+ self.assertEqual(self.session.property_fast('AUTHID'), b'user1')
+ self.assertEqual(self.session.property_get('AUTHID'), b'user1')
+ self.session.property_set_bulk(authid='user2', authzid='user3')
+ self.assertEqual(self.session.property_fast('AUTHID'), b'user2')
+ self.assertEqual(self.session.property_get('AUTHID'), b'user2')
+ self.assertEqual(self.session.property_fast('AUTHZID'), b'user3')
+ self.assertEqual(self.session.property_get('AUTHZID'), b'user3')
+ self.session.property_set('AUTHID', None)
+ self.assertIsNone(self.session.property_fast('AUTHID'))
+ self.assertIsNone(self.session.property_get('AUTHID'))
+
+ def test_step(self):
+ """Test a PLAIN client step."""
+ username = 'username'
+ password = 'password'
+ expect = ('\0%s\0%s' % (username, password)).encode('ascii')
+ self.session.property_set_bulk(authid=username, password=password)
+ output, finished = self.session.step()
+ self.assertTrue(finished)
+ self.assertEqual(output, expect)
+
+ def test_step64(self):
+ """Test a base64-encoded PLAIN client step."""
+ from base64 import b64encode
+ username = 'username'
+ password = 'password'
+ expect = ('\0%s\0%s' % (username, password)).encode('ascii')
+ self.session.property_set_bulk(authid=username, password=password)
+ output, finished = self.session.step64()
+ self.assertTrue(finished)
+ self.assertEqual(output, b64encode(expect).decode('ascii'))
+
+
+class GsaslServerTestCase(GsaslClientTestCase):
+ """Test functions that rely on an initialized server context."""
+
+ def setUp(self):
+ """Set up a server session context."""
+ self.session = Gsasl().server_start(MECH)
+
+ def test_step(self):
+ """Test a PLAIN server step."""
+ output, finished = self.session.step()
+ self.assertFalse(finished)
+ self.assertIsNone(output)
+
+ def test_step64(self):
+ """Test a base64-encoded PLAIN server step."""
+ output, finished = self.session.step64()
+ self.assertFalse(finished)
+ self.assertEqual(output, '')
+
+
+if __name__ == '__main__':
+ main()
diff --git a/lib/python/setup.cfg b/lib/python/setup.cfg
new file mode 100644
index 0000000..3c6e79c
--- /dev/null
+++ b/lib/python/setup.cfg
@@ -0,0 +1,2 @@
+[bdist_wheel]
+universal=1
diff --git a/lib/python/setup.py b/lib/python/setup.py
new file mode 100644
index 0000000..2e7e6a5
--- /dev/null
+++ b/lib/python/setup.py
@@ -0,0 +1,42 @@
+"""Set up package configuration for the gsasl Python bindings"""
+
+try:
+ from setuptools import setup # Try setuptools first for bdist_wheel.
+except ImportError:
+ from distutils.core import setup
+from os import path
+
+
+with open(path.join(path.dirname(__file__), 'README.rst')) as readme_file:
+ README = readme_file.read()
+
+setup(
+ author='David Michael',
+ author_email='address@hidden',
+ classifiers=[
+ 'Development Status :: 3 - Alpha',
+ 'Intended Audience :: Information Technology',
+ ('License :: OSI Approved :: '
+ 'GNU Lesser General Public License v2 or later (LGPLv2+)'),
+ 'Operating System :: OS Independent',
+ 'Programming Language :: Python :: 2',
+ 'Programming Language :: Python :: 2.6',
+ 'Programming Language :: Python :: 2.7',
+ 'Programming Language :: Python :: 3',
+ 'Programming Language :: Python :: 3.2',
+ 'Programming Language :: Python :: 3.3',
+ 'Programming Language :: Python :: 3.4',
+ 'Topic :: Security :: Cryptography',
+ ],
+ description='Python bindings for the GNU SASL library',
+ keywords=['gnu', 'sasl', 'gssapi', 'kerberos'],
+ license='LGPLv2+',
+ long_description=README,
+ maintainer='GNU SASL Maintainers',
+ maintainer_email='address@hidden',
+ name='pygsasl',
+ packages=['gsasl'],
+ platforms=['OS Independent'],
+ url='http://www.gnu.org/software/gsasl',
+ version='1.8.0',
+)
--
2.1.0