]> git.ipfire.org Git - thirdparty/krb5.git/commitdiff
Fix typos in documentation
authorGreg Hudson <ghudson@mit.edu>
Thu, 2 Apr 2020 17:22:45 +0000 (13:22 -0400)
committerGreg Hudson <ghudson@mit.edu>
Wed, 8 Apr 2020 19:10:30 +0000 (15:10 -0400)
Correct documentation spelling errors detected using codespell.
Reported by Jens Schleusener.

ticket: 8891
tags: pullup
target_version: 1.18-next

doc/admin/conf_files/krb5_conf.rst
doc/admin/host_config.rst
doc/admin/pkinit.rst
doc/iprop-notes.txt
doc/kadm5/adb-unit-test.tex
doc/kadm5/api-funcspec.tex
doc/kadm5/api-server-design.tex
doc/kadm5/api-unit-test.tex
doc/mitK5features.rst
doc/rpc/design.tex
src/include/krb5/krb5.hin

index f6822550503ae8ec6bd923272e6050902dccb004..1d2aa7f68100fae2279cf9ac8d2c1e82356307aa 100644 (file)
@@ -1123,7 +1123,7 @@ PKINIT krb5.conf options
     specifies **X509_user_identity** on the command line.
 
 **pkinit_kdc_hostname**
-    The presense of this option indicates that the client is willing
+    The presence of this option indicates that the client is willing
     to accept a KDC certificate with a dNSName SAN (Subject
     Alternative Name) rather than requiring the id-pkinit-san as
     defined in :rfc:`4556`.  This option may be specified multiple
index 91848ff16a231247819173a724e05bb5d7ef7112..4e1db0256e8a94b58c00146ab25669e6ef7f8ec2 100644 (file)
@@ -92,7 +92,7 @@ to principals from a different realm than the default realm::
             # only principals in OTHER.REALM are matched.
             #
             # s/@OTHER\.REALM$// removes the realm name, leaving behind the
-            # principal name as the acount name.
+            # principal name as the account name.
             auth_to_local = RULE:[1:$1@$0](.*@OTHER\.REALM)s/@OTHER\.REALM$//
 
             # Also allow principals from the default realm.  Omit this line
index 8f663f2e5199978c6c205faa6ee53611788b7e7f..45817daca3a4b47b269d2e82da4182d6d4eef01f 100644 (file)
@@ -46,7 +46,7 @@ interoperability issues in rare circumstances.
 The result of these commands will be two files, cakey.pem and
 cacert.pem.  cakey.pem will contain a 2048-bit RSA private key, which
 must be carefully protected.  cacert.pem will contain the CA
-certificate, which must be placed in the filesytems of the KDC and
+certificate, which must be placed in the filesystems of the KDC and
 each client host.  cakey.pem will be required to create KDC and client
 certificates.
 
index 722b0392ee3c5767e773773c19669f88b939baaa..ac573058743d5e062c3535db541af3ef51e30a3f 100644 (file)
@@ -90,7 +90,7 @@ backwards-incompatible ABI changes.)
 
 Overflow checks for ulogentries times block size?
 
-If file can't be made the size indicated by ulogentries, shoud we
+If file can't be made the size indicated by ulogentries, should we
 truncate or error out?  If we error out, this could blow out when
 resizing the log because of a too-large log entry.
 
index 987af1a5ec79d63296da3721a2c351d143c1149f..0595c67293204912eecca558a360a5cdb3a9ffa5 100644 (file)
@@ -53,7 +53,7 @@ Unit Test Description}
 
 The following is a description of a black-box unit test of the
 OpenV*Secure Admin Database API (osa_adb).  Each API function is
-listed, followed by the tests that shoud be performed on it.
+listed, followed by the tests that should be performed on it.
 
 The tests described here are based on the ``OV*Secure Admin Server
 Implementation Design'' revision 1.14.
index 76d2bb5d06e69ca1fad39c8df566707116dc0e93..b633cef1ef33faf2401f2ad8301f56100f7d0a0b 100644 (file)
@@ -522,7 +522,7 @@ typedef struct _krb5_key_data {
 \end{verbatim}
 %
 \begin{description}
-\item[key_data_ver] The verion number of the structure.  Versions 1
+\item[key_data_ver] The version number of the structure.  Versions 1
 and 2 are currently defined.  If key_data_ver is 1 then the key is
 either a random key (not requiring a salt) or the salt is the normal
 v5 salt which is the same as the realm and therefore doesn't need to
@@ -641,7 +641,7 @@ Before \v{\#include}ing $<$kadm5/admin.h$>$, the programmer can
 specify the API version number that the program will use by
 \v{\#define}ing USE_KADM5_API_VERSION; for example, define that symbol
 to be 1 to use KADM5_API_VERSION_1.  This will ensure that the correct
-functional protoypes and data structures are defined.  If no version
+functional prototypes and data structures are defined.  If no version
 symbol is defined, the most recent version supported by the header
 files will be used.
 
@@ -727,7 +727,7 @@ mismatch
 \item[KADM5_BAD_LENGTH] Invalid password length
 \item[KADM5_BAD_POLICY] Illegal policy name
 \item[KADM5_BAD_PRINCIPAL] Illegal principal name.
-\item[KADM5_BAD_AUX_ATTR] Invalid auxillary attributes
+\item[KADM5_BAD_AUX_ATTR] Invalid auxiliary attributes
 \item[KADM5_BAD_HISTORY] Invalid password history count
 \item[KADM5_BAD_MIN_PASS_LIFE] Password minimum life is greater
 then password maximum life
@@ -735,7 +735,7 @@ then password maximum life
 \item[KADM5_PASS_Q_CLASS] Password does not contain enough
 character classes
 \item[KADM5_PASS_Q_DICT] Password is in the password dictionary
-\item[KADM5_PASS_REUSE] Cannot resuse password
+\item[KADM5_PASS_REUSE] Cannot reuse password
 \item[KADM5_PASS_TOOSOON] Current password's minimum life has not
 expired
 \item[KADM5_POLICY_REF] Policy is in use
@@ -962,7 +962,7 @@ NOTE: kadm5_init is an obsolete function provided for backwards
 compatibility.  It is identical to kadm5_init_with_password.
 
 These three functions open a connection to the kadm5 library and
-initialize any neccessary state information.  They behave differently
+initialize any necessary state information.  They behave differently
 when called from local and remote clients.  
 
 In KADM5_API_VERSION_2, these functions take a kadm5_config_params
@@ -1444,7 +1444,7 @@ terminal-based applications will make use of the password reading
 functionality. If the passwords don't match the string ``New passwords do
 not match - password not changed.'' will be copied into msg_ret, and the
 error code KRB5_LIBOS_BADPWDMATCH will be returned.  For other errors that
-ocurr while reading the new password, copy the string ``<com_err message$>$
+occur while reading the new password, copy the string ``<com_err message$>$
 occurred while trying to read new password.'' followed by a blank line and
 the string specified by CHPASS_UTIL_PASSWORD_NOT_CHANGED into msg_ret and
 return the error code returned by krb5_read_password.
@@ -1951,7 +1951,7 @@ void kadm5_free_policy_ent(kadm5_policy_ent_t policy);
 \end{verbatim}
 
 Free memory that was allocated by a call to kadm5_get_policy.  If
-the argument is NULL, the function returns succesfully.
+the argument is NULL, the function returns successfully.
 
 AUTHORIZATION REQUIRED: none (local operation)
 
index 94e05b877852133c20971dbe01665b741803041b..2cf0fe84f363e68d963ac68a25f53b0f2ba4a9b6 100644 (file)
@@ -187,7 +187,7 @@ The following functions describe how each context is handled.
 
 Any code whose behavior depends on the API version should be written
 so as to be compatible with future, currently unknown API versions on
-the grounds that any particuarly piece of API behavior will most
+the grounds that any particular piece of API behavior will most
 likely not change between versions.  For example, in the current
 system, the code is not written as ``if this is VERSION_1, do X, else
 if this is VERSION_2, do Y''; instead, it is written as ``if this is
@@ -235,7 +235,7 @@ kadm5_ret_t    kadm5_get_principal(void *server_handle,
 Server library functions must know how many and what type of arguments
 to expect, and must operate on those arguments correctly, based on the
 API version with which they are invoked.  The API version is contained
-in the handle that is alwasy passed as their first argument, generated
+in the handle that is always passed as their first argument, generated
 by kadm5_init_* (to which the client specified the API version to use
 at run-time).
 
@@ -422,7 +422,7 @@ kadm5_get_principal in the server library, it must give that function
 an API handle that contains the API version requested by the client;
 otherwise the function semantics might not be correct.  One
 possibility would be for the server to call kadm5_init for each client
-request, specifing the client's API version number and thus generating
+request, specifying the client's API version number and thus generating
 an API handle with the correct version, but that would be
 prohibitively inefficient.  Instead, the server dips down in the
 server library's internal abstraction barrier, using the function
@@ -487,7 +487,7 @@ kadm5_chpass_principal did not change between VERSION_1 and VERSION_2,
 the declarations of both kadm5_get_principal and kadm5_get_policy
 did.  Thus, to use the caller's API handle, kadm5_chpass_principal
 will have to have a separate code path for each API version, even
-though it itself did not change bewteen versions, and duplicate a lot
+though it itself did not change between versions, and duplicate a lot
 of logic found elsewhere in the library.
 
 Instead, each API handle contains a ``local-use handle,'' or lhandle,
@@ -528,7 +528,7 @@ This scheme might break down if a kadm5 function has to call another
 kadm5 function to perform operations that they client will see and for
 its own benefit, since the semantics of the recursively-called kadm5
 function may depend on the API version specified and the client may be
-depending on a particular version's behavior.  Future implementators
+depending on a particular version's behavior.  Future implementors
 should avoid creating a situation in which this is possible.
 
 \section{Server Main}
@@ -710,7 +710,7 @@ and deallocate the db structure.
 \end{enumerate}
 
 Functions which modify the database acquire an exclusive lock, others
-acqure a shared lock.  osa_adb_iter_T acquires an exclusive lock for
+acquire a shared lock.  osa_adb_iter_T acquires an exclusive lock for
 safety but as stated below consequences of modifying the database in
 the iteration function are undefined.
 
@@ -881,7 +881,7 @@ osa_adb_ret_t osa_adb_iter_T(osa_adb_T_t db, osa_adb_iter_T_func func,
 Iterates over every entry in the database.  For each entry ent in the
 database db, the function (*func)(data, ent) is called.  If func
 returns an error code, osa_adb_iter_T returns an error code.  If all
-invokations of func return OSA_ADB_OK, osa_adb_iter_T returns
+invocations of func return OSA_ADB_OK, osa_adb_iter_T returns
 OSA_ADB_OK.  The function func is permitted to access the database,
 but the consequences of modifying the database during the iteration
 are undefined.
@@ -985,7 +985,7 @@ privilege, 0 if it does not.
 \section{Function Details}
 
 This section discusses specific design issues for Admin API functions
-that are not addresed by the functional specifications.
+that are not addressed by the functional specifications.
 
 \subsection{kadm5_create_principal}
 
index bfd6280bb026cd4c9bd66ce67ba0ee10eeaf653a..0142420370cf7727b37330a3ad22816e06c227f0 100644 (file)
@@ -54,7 +54,7 @@ Unit Test Description}
 \section{Introduction}
 
 The following is a description of a black-box unit test of the KADM5
-API.  Each API function is listed, followed by the tests that shoud be
+API.  Each API function is listed, followed by the tests that should be
 performed on it.
 
 The tests described here are based on the ``Kerberos Administration
@@ -444,7 +444,7 @@ if set with only an admin server name.}
 
 \numtest{102.5}{
 \Version{KADM5_API_VERSION_2}
-\Reason{Obeys the admin_server field of the configuratin parameters,
+\Reason{Obeys the admin_server field of the configuration parameters,
 if set with a host name and port number.}
 \Conditions{RPC}
 }
@@ -556,7 +556,7 @@ are specified to server-side init.}
 \numtest{116}{
 \Version{KADM5_API_VERSION_2}
 \Reason{Two calls to init with clients having different privileges
-succeedes, and both clients maintain their correct privileges.}
+succeeds, and both clients maintain their correct privileges.}
 \Priority{Bug fix}
 \Conditions{RPC}
 \Status{Implemented}
@@ -663,7 +663,7 @@ that does not exist, init fails with ENOENT.}
 
 \numtest{10}{
 \Priority{Low}
-\Reason{Connects to correct server when mutliple handles exist}
+\Reason{Connects to correct server when multiple handles exist}
 \Conditions{client}
 }
 
@@ -932,7 +932,7 @@ that does not exist, init fails with ENOENT.}
 
 \numtest{44}{
 \Priority{Low}
-\Reason{Connects to correct server when mutliple handles exist}
+\Reason{Connects to correct server when multiple handles exist}
 \Conditions{RPC}
 }
 
@@ -1020,7 +1020,7 @@ that does not exist, init fails with ENOENT.}
 
 \numtest{14}{
 \Priority{Low}
-\Reason{Connects to correct server when mutliple handles exist}
+\Reason{Connects to correct server when multiple handles exist}
 \Conditions{RPC}
 }
 
@@ -1309,7 +1309,7 @@ no pw_expiration is specified.}
 
 \numtest{44}{
 \Priority{Low}
-\Reason{Connects to correct server when mutliple handles exist}
+\Reason{Connects to correct server when multiple handles exist}
 \Conditions{RPC}
 }
 
@@ -1465,7 +1465,7 @@ has non-name-based salt.}
 
 \numtest{17}{
 \Priority{Low}
-\Reason{Connects to correct server when mutliple handles exist}
+\Reason{Connects to correct server when multiple handles exist}
 \Conditions{RPC}
 }
 
@@ -1721,7 +1721,7 @@ Base & Modify access? & Own password? & Service & Pass/Fail \\ \hline
 
 \numtest{184}{
 \Priority{Low}
-\Reason{Connects to correct server when mutliple handles exist}
+\Reason{Connects to correct server when multiple handles exist}
 \Conditions{RPC}
 }
 
@@ -1901,7 +1901,7 @@ Number & Modify Access? & Own Key? & Service & Pass/Fail & Implemented? \\ \hlin
 
 \numtest{34}{
 \Priority{Low}
-\Reason{Connects to correct server when mutliple handles exist}
+\Reason{Connects to correct server when multiple handles exist}
 \Conditions{RPC}
 }
 
@@ -2014,7 +2014,7 @@ keysalts.}
 
 \numtest{16}{
 \Priority{Low}
-\Reason{Connects to correct server when mutliple handles exist}
+\Reason{Connects to correct server when multiple handles exist}
 \Conditions{RPC}
 }
 
@@ -2232,7 +2232,7 @@ correct tl_data and no entries whose type is less than 256.}
 
 \numtest{31}{
 \Priority{Low}
-\Reason{Connects to correct server when mutliple handles exist}
+\Reason{Connects to correct server when multiple handles exist}
 \Conditions{RPC}
 }
 
@@ -2312,7 +2312,7 @@ correct tl_data and no entries whose type is less than 256.}
 
 \numtest{14}{
 \Priority{Low}
-\Reason{Connects to correct server when mutliple handles exist}
+\Reason{Connects to correct server when multiple handles exist}
 \Conditions{RPC}
 }
 
@@ -2486,7 +2486,7 @@ correct tl_data and no entries whose type is less than 256.}
 
 \numtest{31}{
 \Priority{Low}
-\Reason{Connects to correct server when mutliple handles exist}
+\Reason{Connects to correct server when multiple handles exist}
 \Conditions{RPC}
 }
 
@@ -2617,7 +2617,7 @@ correct tl_data and no entries whose type is less than 256.}
 
 \numtest{22}{
 \Priority{Low}
-\Reason{Connects to correct server when mutliple handles exist}
+\Reason{Connects to correct server when multiple handles exist}
 \Conditions{RPC}
 }
 
index d58c71898a43acc0f77048aa6fe0b9d709e47d74..98c1435d7fc5108b817163c170fde8452a8e2e29 100644 (file)
@@ -112,7 +112,7 @@ Release 1.9
  -   Plugin to test password quality           :ref:`pwqual_plugin`
  -   Plugin to synchronize password changes    :ref:`kadm5_hook_plugin`
  -   Parallel KDC
- -   GSS-API extentions for SASL GS2 bridge    :rfc:`5801` :rfc:`5587`
+ -   GSS-API extensions for SASL GS2 bridge    :rfc:`5801` :rfc:`5587`
  -   Purging old keys
  -   Naming extensions for delegation chain
  -   Password expiration API
index fbd60f9144bd37235178f16f98c878a20058fba4..801034b0f8006a590df51aea7a468784493072b1 100644 (file)
@@ -519,7 +519,7 @@ flavor initialization routine.  The service side, however, is more
 complex.  In the normal course of events, an RPC call comes in, is
 authenticated, and is then dispatched to the appropriate procedure.
 For client- and service-side authentication flavors to communicate
-indepedent of the server implemented above the RPC layer, the
+independent of the server implemented above the RPC layer, the
 service-side flavor must be able to send a reply to the client
 directly and {\it prevent} the call from being dispatched.
 
@@ -580,7 +580,7 @@ Server Transport Mechanisms     & svc_udp.c \\
 
 \section{GSS-API Authentication Flavor}
 
-The following sections describe the implemetation of the GSS-API
+The following sections describe the implementation of the GSS-API
 authentication flavor for Sun RPC.
 
 \subsection{Authentication Algorithms}
@@ -640,7 +640,7 @@ output token is generated, it is returned to the client.  Note that
 since the application server may have registered multiple service
 names and there is no way to determine {\it a priori} which service a
 token is for, _svcauth_gssapi calls gss_accept_sec_context once for
-each registered credential until one of them succeedes.  The code
+each registered credential until one of them succeeds.  The code
 assumes that GSS_S_FAILURE is the only error that can result from a
 credential mismatch, so any other error terminates the loop
 immediately.
@@ -661,7 +661,7 @@ processed).  The reverse is also true.
 \subsubsection{RPC Calls}
 
 After the GSS-API context is established, both the server and the
-client posess a client handle and a corresponding sequence number.
+client possess a client handle and a corresponding sequence number.
 Each call from the client contains the client handle as the
 ``credential'' so that the server can identify which context to apply
 to the call.
@@ -704,7 +704,7 @@ The auth_msg field indicates whether the message is intended for the
 authentication mechanism for the actual server.  Any message whose
 auth_msg field is true is processed by the authentication mechanism;
 any message whose auth_msg is false is passed to the application
-server's dispatch function if authentication suceeds.  All messages
+server's dispatch function if authentication succeeds.  All messages
 must have an auth_msg of true until the context is established, since
 authentication cannot succeed until it is.
 
@@ -876,7 +876,7 @@ an RPC_SUCCESS response is received, verifies that the returned sequence
 number is one greater than the previous value sent by
 auth_gssapi_marshall.
 
-Finally, auth_gssapi_unwrap, invokved by the client-side RPC mechanism
+Finally, auth_gssapi_unwrap, invoked by the client-side RPC mechanism
 after auth_gssapi_validate succeeds, performs the same operation as
 svc_auth_gssapi_unwrap.
 
@@ -940,7 +940,7 @@ calls except the first one; the handle is obtained as the result of
 the first call.
 
 The sequence_number field contains the sequence number that will be
-used when transmitting RPC calls to the server and verifing the
+used when transmitting RPC calls to the server and verifying the
 server's responses after the context is initialized.
 
 The def_cred field is true if gss_init_sec_context created a default
index b3aea90b0b04f29b295bbe9d9991d6eab65d3f57..c483ebcb0fade61143569e094ee91271605cfc57 100644 (file)
@@ -1685,7 +1685,7 @@ krb5_verify_checksum(krb5_context context, krb5_cksumtype ctype,
 
 /*
  * Mask of ticket flags in the TGT which should be converted into KDC
- * options when using the TGT to get derivitive tickets.
+ * options when using the TGT to get derivative tickets.
  *
  *  New mask = KDC_OPT_FORWARDABLE | KDC_OPT_PROXIABLE |
  *             KDC_OPT_ALLOW_POSTDATE | KDC_OPT_RENEWABLE
@@ -3175,7 +3175,7 @@ krb5_mk_req(krb5_context context, krb5_auth_context *auth_context,
  *                                request used for user to user
  *                                authentication.
  * @li #AP_OPTS_MUTUAL_REQUIRED - Request a mutual authentication packet from
- *                                the reciever.
+ *                                the receiver.
  * @li #AP_OPTS_USE_SUBKEY      - Generate a subsession key from the current
  *                                session key obtained from the credentials.
  *
@@ -5997,7 +5997,7 @@ krb5_auth_con_initivector(krb5_context context, krb5_auth_context auth_context);
  *
  * This function sets the replay cache in @a auth_context to @a rcache.  @a
  * rcache will be closed when @a auth_context is freed, so the caller should
- * relinguish that responsibility.
+ * relinquish that responsibility.
  *
  * @retval 0 Success; otherwise - Kerberos error codes
  */
@@ -8364,7 +8364,7 @@ krb5_pac_get_client_info(krb5_context context, const krb5_pac pac,
                          krb5_timestamp *authtime_out, char **princname_out);
 
 /**
- * Allow the appplication to override the profile's allow_weak_crypto setting.
+ * Allow the application to override the profile's allow_weak_crypto setting.
  *
  * @param [in] context          Library context
  * @param [in] enable           Boolean flag