PKG-INFO 7.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205
  1. Metadata-Version: 1.1
  2. Name: gssapi
  3. Version: 1.5.1
  4. Summary: Python GSSAPI Wrapper
  5. Home-page: https://github.com/pythongssapi/python-gssapi
  6. Author: The Python GSSAPI Team
  7. Author-email: sross@redhat.com
  8. License: LICENSE.txt
  9. Description: =============
  10. Python-GSSAPI
  11. =============
  12. .. image:: https://travis-ci.org/pythongssapi/python-gssapi.svg?branch=master
  13. :target: https://travis-ci.org/pythongssapi/python-gssapi
  14. .. image:: https://badge.fury.io/gh/pythongssapi%2Fpython-gssapi.svg
  15. :target: http://badge.fury.io/gh/pythongssapi%2Fpython-gssapi
  16. .. image:: https://badge.fury.io/py/gssapi.svg
  17. :target: http://badge.fury.io/py/gssapi
  18. Python-GSSAPI provides both low-level and high level wrappers around the GSSAPI
  19. C libraries. While it focuses on the Kerberos mechanism, it should also be
  20. useable with other GSSAPI mechanisms.
  21. Documentation for the latest released version (including pre-release versions)
  22. can be found at
  23. `https://pythongssapi.github.io/python-gssapi/stable <https://pythongssapi.github.io/python-gssapi/stable>`_.
  24. Documentation for the latest commit on master can be found at
  25. `https://pythongssapi.github.io/python-gssapi/latest <https://pythongssapi.github.io/python-gssapi/latest>`_.
  26. Requirements
  27. ============
  28. Basic
  29. -----
  30. * A working implementation of GSSAPI (such as from MIT Kerberos)
  31. which includes header files
  32. * a C compiler (such as GCC)
  33. * either the `enum34` Python package or Python 3.4+
  34. * the `six` and `decorator` python packages
  35. Compiling from Scratch
  36. ----------------------
  37. To compile from scratch, you will need Cython >= 0.21.1.
  38. For Running the Tests
  39. ---------------------
  40. * the `nose` package (for tests)
  41. * the `shouldbe` package (for tests)
  42. * the `k5test` package
  43. To install test dependencies using pip:
  44. ::
  45. $ pip install -r test-requirements.txt # Optional, for running test suite
  46. Installation
  47. ============
  48. Easy Way
  49. --------
  50. ::
  51. $ pip install gssapi
  52. From the Git Repo
  53. -----------------
  54. After being sure to install all the requirements,
  55. ::
  56. $ git clone https://github.com/pythongssapi/python-gssapi.git
  57. $ python setup.py build
  58. $ python setup.py install
  59. Tests
  60. =====
  61. The tests for for Python-GSSAPI live in `gssapi.tests`. In order to
  62. run the tests, you must have an MIT Kerberos installation (including
  63. the KDC). The tests create a self-contained Kerberos setup, so running
  64. the tests will not interfere with any existing Kerberos installations.
  65. Structure
  66. =========
  67. Python-GSSAPI is composed of two parts: a low-level C-style API which
  68. thinly wraps the underlying RFC 2744 methods, and a high-level, Pythonic
  69. API (which is itself a wrapper around the low-level API). Examples may
  70. be found in the `examples` directory.
  71. Low-Level API
  72. -------------
  73. The low-level API lives in `gssapi.raw`. The methods contained therein
  74. are designed to match closely with the original GSSAPI C methods. All
  75. relevant methods and classes may be imported directly from `gssapi.raw`.
  76. Extension methods will only be imported if they are present. The low-level
  77. API follows the given format:
  78. * Names match the RFC 2744 specification, with the `gssapi_`
  79. prefix removed
  80. * Parameters which use C int constants as enums have
  81. `enum.IntEnum` classes defined, and thus may be passed
  82. either the enum members or integers
  83. * In cases where a specific constant is passed in the C API to represent
  84. a default value, `None` should be passed instead
  85. * In cases where non-integer constants would be used in the API (i.e.
  86. OIDs), enum-like objects have been defined containing named references
  87. to values specified in RFC 2744.
  88. * Major and minor error codes are returned by raising
  89. `gssapi.raw.GSSError`. The major error codes have exceptions
  90. defined in in `gssapi.raw.exceptions` to make it easier to catch specific
  91. errors or categories of errors.
  92. * All other relevant output values are returned via named tuples.
  93. High-Level API
  94. --------------
  95. The high-level API lives directly under `gssapi`. The classes
  96. contained in each file are designed to provide a more Pythonic, Object-Oriented
  97. view of GSSAPI. The exceptions from the low-level API, plus several additional
  98. exceptions, live in `gssapi.exceptions`. The rest of the classes may be
  99. imported directly from `gssapi`. Only classes are exported by `gssapi` --
  100. all functions are methods of classes in the high-level API.
  101. Please note that QoP is not supported in the high-level API, since it has been
  102. deprecated.
  103. Extensions
  104. ----------
  105. In addition to RFC 2743/2744, Python-GSSAPI also has support for:
  106. * RFC 5587 (Extended GSS Mechanism Inquiry APIs)
  107. * RFC 5588 (GSS-API Extension for Storing Delegated Credentials)
  108. * (Additional) Credential Store Extension
  109. * Services4User
  110. * Credentials import-export
  111. * RFC 6680 (GSS-API Naming Extensions)
  112. * DCE and IOV MIC extensions
  113. * `acquire_cred_with_password` and `add_cred_with_password`
  114. * GGF Extensions
  115. The Team
  116. ========
  117. (GitHub usernames in parentheses)
  118. * Solly Ross (@directxman12)
  119. * Robbie Harwood (@frozencemetery)
  120. * Simo Sorce (@simo5)
  121. * Hugh Cole-Baker (@sigmaris)
  122. Get Involved
  123. ============
  124. We welcome new contributions in the form of Issues and Pull Requests on
  125. Github. If you would like to join our discussions, you can find us on
  126. `Freenode <https://webchat.freenode.net/>`_ IRC, channel `#python-gssapi
  127. <irc://freenode.net/python-gssapi>`_.
  128. Keywords: gssapi,security
  129. Platform: UNKNOWN
  130. Classifier: Development Status :: 4 - Beta
  131. Classifier: Programming Language :: Python
  132. Classifier: Programming Language :: Python :: 2.7
  133. Classifier: Programming Language :: Python :: 3
  134. Classifier: Programming Language :: Python :: 3.3
  135. Classifier: Intended Audience :: Developers
  136. Classifier: License :: OSI Approved :: ISC License (ISCL)
  137. Classifier: Programming Language :: Python :: Implementation :: CPython
  138. Classifier: Programming Language :: Cython
  139. Classifier: Topic :: Security
  140. Classifier: Topic :: Software Development :: Libraries :: Python Modules