Skip to content

Commit a69d821

Browse files
frozencemeterysimo5
authored andcommitted
[docs] Clean up cred store extension reference
1 parent b90b406 commit a69d821

File tree

1 file changed

+26
-23
lines changed

1 file changed

+26
-23
lines changed

docs/source/credstore.rst

Lines changed: 26 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -2,16 +2,16 @@ Common Values for Credentials Store Extensions
22
==============================================
33

44
The credentials store extension is an extension introduced by the MIT krb5
5-
library implementation of GSSAPI. It allows for finer control of credentials
6-
from within a GSSAPI application.
7-
Each mechanism can define keywords to manipulate various aspects of their
8-
credentials for storage or retrieval operations.
5+
library implementation of GSSAPI. It allows for finer control of credentials
6+
from within a GSSAPI application. Each mechanism can define keywords to
7+
manipulate various aspects of their credentials for storage or retrieval
8+
operations.
99

1010
.. note:
1111
12-
Only mechanisms that implement keywords can use them, some mechanism may
13-
share the same or similar keywords, but their meaning is always local to
14-
a specific mechanism.
12+
Only mechanisms that implement keywords can use them: some mechanisms may
13+
share the same or similar keywords, but their meaning is always local to a
14+
specific mechanism.
1515
1616
The krb5 mechanism in MIT libraries
1717
-----------------------------------
@@ -24,25 +24,27 @@ client_keytab
2424

2525
The `client_keytab` keyword can be used in a credential store when it is used
2626
with the :func:`gssapi.raw.ext_cred_store.acquire_cred_from` /
27-
:func:`gssapi.raw.ext_cred_store.add_cred_from` functions, to indicate a
28-
custom location for a keytab containing client keys.
29-
It is not used in the context of calls used to store credentials.
27+
:func:`gssapi.raw.ext_cred_store.add_cred_from` functions to indicate a custom
28+
location for a keytab containing client keys. It is not used in the context
29+
of calls used to store credentials.
30+
3031
The value is a string in the form **type:residual** where **type** can be any
3132
keytab storage type understood by the implementation and **residual** is the
32-
keytab identifier (usually something like a path). If the string is just a path
33+
keytab identifier (usually something like a path). If the string is a path,
3334
then the type is defaulted to `FILE`.
3435

3536
keytab
3637
""""""
3738

3839
The `keytab` keyword can be used in a credential store when it is used with
3940
the :func:`gssapi.raw.ext_cred_store.acquire_cred_from` /
40-
:func:`gssapi.raw.ext_cred_store.add_cred_from` functions, to indicate a
41-
custom location for a keytab containing service keys.
42-
It is not used in the context of calls used to store credentials.
41+
:func:`gssapi.raw.ext_cred_store.add_cred_from` functions to indicate a custom
42+
location for a keytab containing service keys. It is not used in the context
43+
of calls used to store credentials.
44+
4345
The value is a string in the form **type:residual** where **type** can be any
4446
keytab storage type understood by the implementation and **residual** is the
45-
keytab identifier (usually something like a path). If the string is just a path
47+
keytab identifier (usually something like a path). If the string is a path,
4648
then the type is defaulted to `FILE`.
4749

4850
ccache
@@ -54,11 +56,12 @@ It can be used both to indicate the source of existing credentials for the
5456
:func:`gssapi.raw.ext_cred_store.add_cred_from` functions, as well as the
5557
destination storage for the :func:`gssapi.raw.ext_cred_store.store_cred_into`
5658
function.
57-
The value is a string in the form **type:residual** where type can be any
59+
60+
The value is a string in the form **type:residual** where **type** can be any
5861
credential cache storage type understood by the implementation and
59-
**residual** is the ccache identifier. If the string is just a path then
60-
the type is defaulted to `FILE`. Other commonly used types are `DIR`,
61-
`KEYRING`, `KCM`. Each type has a different format for the **residual**;
62+
**residual** is the ccache identifier. If the string is a path, then the type
63+
is defaulted to `FILE`. Other commonly used types are `DIR`, `KEYRING`,
64+
`KCM`, and `MEMORY`. Each type has a different format for the **residual**;
6265
refer to the MIT krb5 documentation for more details.
6366

6467
rcache
@@ -68,8 +71,8 @@ The `rcache` keyword can be used to reference a custom replay cache storage.
6871
It is used only with the :func:`gssapi.raw.ext_cred_store.acquire_cred_from` /
6972
:func:`gssapi.raw.ext_cred_store.add_cred_from` functions for credentials used
7073
to accept context establishments, not to initiate contexts.
71-
The value is a string in the form **type:residual** where type can be any
72-
replay cache storage type understood by the implementation and **residual** is
73-
the cache identifier (usually something like a path). If the string is just a
74-
path then the type is defaulted to `FILE`.
7574

75+
The value is a string in the form **type:residual** where **type** can be any
76+
replay cache storage type understood by the implementation and **residual** is
77+
the cache identifier (usually something like a path). If the string is a
78+
path, then the type is defaulted to `FILE`.

0 commit comments

Comments
 (0)