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
|
Low-Level API
=============
.. py:module:: gssapi.raw
The low-level API contains a variety of Python functions that map directly
to the corresponding C functions. Additionally, it contains several basic
wrapper classes that wrap underlying C structs and automatically deallocate
them when the Python object itself is deallocated.
.. warning::
All methods in both the high-level and low-level APIs may throw the generic
GSSError exception.
Core RFC 2744
-------------
Names
~~~~~
.. note::
Some functions in the following section will refer to
"mechanism names". These are not names of mechanisms.
Instead, they are a special form of name specific to
a given mechanism.
.. autoapimodule:: gssapi.raw.names
:members:
:undoc-members:
Credentials
~~~~~~~~~~~
.. autoapimodule:: gssapi.raw.creds
:members:
:undoc-members:
Security Contexts
~~~~~~~~~~~~~~~~~
.. autoapimodule:: gssapi.raw.sec_contexts
:members:
:undoc-members:
.. autoapimodule:: gssapi.raw.message
:members:
:undoc-members:
Misc
~~~~
.. autoapimodule:: gssapi.raw.oids
:members:
:undoc-members:
.. autoapimodule:: gssapi.raw.misc
:members:
:undoc-members:
.. autoapimodule:: gssapi.raw.types
:members:
:undoc-members:
.. autoapimodule:: gssapi.raw.chan_bindings
:members:
:undoc-members:
Additional RFCs and Extensions
------------------------------
The following is a list of GSSAPI extensions supported by the low-level API.
.. note::
While all of these extensions have bindings, they may not be supported
by your particularly GSSAPI implementation. In this case, they will not
be compiled, and will simply not be available in the :mod:`gssapi.raw`
namespace.
:rfc:`4178` (GSS-API Negotiation Mechanism)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. autoapimodule:: gssapi.raw.ext_rfc4178
:members:
:undoc-members:
:rfc:`5587` (GSS-API Extension for Mech Attributes)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. autoapimodule:: gssapi.raw.ext_rfc5587
:members:
:undoc-members:
:rfc:`5588` (GSS-API Extension for Storing Delegated Credentials)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. autoapimodule:: gssapi.raw.ext_rfc5588
:members:
:undoc-members:
:rfc:`5801` (GSS-API SASL Extensions)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. autoapimodule:: gssapi.raw.ext_rfc5801
:members:
:undoc-members:
Credential Store Extensions
~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. autoapimodule:: gssapi.raw.ext_cred_store
:members:
:undoc-members:
:rfc:`6680` (GSS-API Naming Extensions)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. autoapimodule:: gssapi.raw.ext_rfc6680
:members:
:undoc-members:
Credentials Import-Export Extensions
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. autoapimodule:: gssapi.raw.ext_cred_imp_exp
:members:
:undoc-members:
DCE (IOV/AEAD) Extensions
~~~~~~~~~~~~~~~~~~~~~~~~~
.. autoapimodule:: gssapi.raw.ext_dce
:members:
:undoc-members:
..
gssapi.raw.ext_dce_aead is imported with ext_dce so no need to double up.
IOV MIC Extensions
~~~~~~~~~~~~~~~~~~
.. autoapimodule:: gssapi.raw.ext_iov_mic
:members:
:undoc-members:
Global Grid Forum (GGF) Extensions
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. autoapimodule:: gssapi.raw.ext_ggf
:members:
:undoc-members:
Services4User Extensions
~~~~~~~~~~~~~~~~~~~~~~~~
.. autoapimodule:: gssapi.raw.ext_s4u
:members:
:undoc-members:
Acquiring Credentials With a Password Extensions
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. autoapimodule:: gssapi.raw.ext_password
:members:
:undoc-members:
.. autoapimodule:: gssapi.raw.ext_password_add
:members:
:undoc-members:
Kerberos Specific Extensions
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. autoapimodule:: gssapi.raw.ext_krb5
:members:
:undoc-members:
Other Extensions
~~~~~~~~~~~~~~~~
.. autoapimodule:: gssapi.raw.ext_set_cred_opt
:members:
:undoc-members:
Results
-------
..
Use autoapimodule once
https://github.com/readthedocs/sphinx-autoapi/issues/323 is resolved.
.. automodule:: gssapi.raw.named_tuples
:members:
:undoc-members:
Exceptions
----------
.. autoapimodule:: gssapi.raw.exceptions
:members:
:undoc-members:
:show-inheritance:
|