x509_vfy.c: extend documenting comment for X509_STORE_CTX_purpose_inherit()

Reviewed-by: Paul Dale <ppzgs1@gmail.com>
Reviewed-by: Tomas Mraz <tomas@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/18764)
This commit is contained in:
Dr. David von Oheimb 2024-12-09 22:03:30 +01:00 committed by Tomas Mraz
parent dbc25b841e
commit 2ddd5df308
1 changed files with 8 additions and 5 deletions

View File

@ -2606,12 +2606,15 @@ int X509_STORE_CTX_set_trust(X509_STORE_CTX *ctx, int trust)
}
/*
* This function is used to set the X509_STORE_CTX purpose and trust values.
* Use this function to set the X509_STORE_CTX purpose and/or trust id values.
* The |def_purpose| argument is used if the given purpose value is 0.
* The |purpose| is unchanged if also the def_purpose argument is 0.
* The |trust| is unchanged if the given trust value is X509_TRUST_DEFAULT.
* This is intended to be used when another structure has its own trust and
* purpose values which (if set) will be inherited by the ctx. If they aren't
* set then we will usually have a default purpose in mind which should then
* be used to set the trust value. An example of this is SSL use: an SSL
* structure will have its own purpose and trust settings which the
* purpose values, which (if set) will be inherited by the |ctx|. If they aren't
* set then we will usually have a default purpose in mind, which should then
* be used to set the trust id. An example of this is SSL use: an SSL
* structure will have its own purpose and trust settings, which the
* application can set: if they aren't set then we use the default of SSL
* client/server.
*/