diff options
author | Sean DuBois <sean@siobud.com> | 2019-07-11 08:24:41 +0100 |
---|---|---|
committer | Sean DuBois <sean@siobud.com> | 2019-07-11 12:04:58 +0100 |
commit | b173a64e132c4321ded7ea4adb8c0c0614941e4a (patch) | |
tree | a10150451c1a6ecfd309b0d75423bd44ad08ea90 | |
parent | 9b77ac5e27121c8b2ede50e3c501fd2c5d7c97b2 (diff) | |
download | libsrtp2-b173a64e132c4321ded7ea4adb8c0c0614941e4a.tar.gz |
Fix docs crypto_policy_* -> srtp_crypto_policy_*
-rw-r--r-- | README.md | 12 | ||||
-rw-r--r-- | include/srtp.h | 18 |
2 files changed, 15 insertions, 15 deletions
@@ -138,16 +138,16 @@ can also be linked together to form an entire session policy. A linked list of `srtp_policy_t` structures is equivalent to a session policy. In such a policy, we refer to a single `srtp_policy_t` as an *element*. -An `srtp_policy_t` strucutre contains two `crypto_policy_t` structures +An `srtp_policy_t` structure contains two `srtp_crypto_policy_t` structures that describe the cryptograhic policies for RTP and RTCP, as well as the SRTP master key and the SSRC value. The SSRC describes what to -protect (e.g. which stream), and the `crypto_policy_t` structures +protect (e.g. which stream), and the `srtp_crypto_policy_t` structures describe how to protect it. The key is contained in a policy element because it simplifies the interface to the library. In many cases, it is desirable to use the same cryptographic policies across all of the streams in a session, but to use a distinct key for each stream. A -`crypto_policy_t` structure can be initialized by using either the -`crypto_policy_set_rtp_default()` or `crypto_policy_set_rtcp_default()` +`srtp_crypto_policy_t` structure can be initialized by using either the +`srtp_crypto_policy_set_rtp_default()` or `srtp_crypto_policy_set_rtcp_default()` functions, which set a crypto policy structure to the default policies for RTP and RTCP protection, respectively. @@ -446,8 +446,8 @@ srtp_init(); memset(&policy, 0x0, sizeof(srtp_policy_t)); // set policy to describe a policy for an SRTP stream -crypto_policy_set_rtp_default(&policy.rtp); -crypto_policy_set_rtcp_default(&policy.rtcp); +srtp_crypto_policy_set_rtp_default(&policy.rtp); +srtp_crypto_policy_set_rtcp_default(&policy.rtcp); policy.ssrc = ssrc; policy.key = key; policy.next = NULL; diff --git a/include/srtp.h b/include/srtp.h index 1fdd6c3..c86b9ee 100644 --- a/include/srtp.h +++ b/include/srtp.h @@ -682,14 +682,14 @@ srtp_err_status_t srtp_update_stream(srtp_t session, * * @param p is a pointer to the policy structure to be set * - * The function call crypto_policy_set_rtp_default(&p) sets the - * crypto_policy_t at location p to the SRTP default policy for RTP + * The function call srtp_crypto_policy_set_rtp_default(&p) sets the + * srtp_crypto_policy_t at location p to the SRTP default policy for RTP * protection, as defined in the specification. This function is a * convenience that helps to avoid dealing directly with the policy * data structure. You are encouraged to initialize policy elements * with this function call. Doing so may allow your code to be * forward compatible with later versions of libSRTP that include more - * elements in the crypto_policy_t datatype. + * elements in the srtp_crypto_policy_t datatype. * * @return void. * @@ -934,7 +934,7 @@ void srtp_crypto_policy_set_aes_cm_256_null_auth(srtp_crypto_policy_t *p); * @param p is a pointer to the policy structure to be set * * The function call srtp_crypto_policy_set_aes_cm_192_hmac_sha1_80(&p) - * sets the crypto_policy_t at location p to use policy + * sets the srtp_crypto_policy_t at location p to use policy * AES_CM_192_HMAC_SHA1_80 as defined in RFC 6188. This policy uses AES-192 * Counter Mode encryption and HMAC-SHA1 authentication, with an 80 bit * authentication tag. @@ -943,7 +943,7 @@ void srtp_crypto_policy_set_aes_cm_256_null_auth(srtp_crypto_policy_t *p); * with the policy data structure. You are encouraged to initialize * policy elements with this function call. Doing so may allow your * code to be forward compatible with later versions of libSRTP that - * include more elements in the crypto_policy_t datatype. + * include more elements in the srtp_crypto_policy_t datatype. * * @return void. * @@ -958,7 +958,7 @@ void srtp_crypto_policy_set_aes_cm_192_hmac_sha1_80(srtp_crypto_policy_t *p); * @param p is a pointer to the policy structure to be set * * The function call srtp_crypto_policy_set_aes_cm_192_hmac_sha1_32(&p) - * sets the crypto_policy_t at location p to use policy + * sets the srtp_crypto_policy_t at location p to use policy * AES_CM_192_HMAC_SHA1_32 as defined in RFC 6188. This policy uses AES-192 * Counter Mode encryption and HMAC-SHA1 authentication, with an * authentication tag that is only 32 bits long. This length is @@ -970,7 +970,7 @@ void srtp_crypto_policy_set_aes_cm_192_hmac_sha1_80(srtp_crypto_policy_t *p); * with the policy data structure. You are encouraged to initialize * policy elements with this function call. Doing so may allow your * code to be forward compatible with later versions of libSRTP that - * include more elements in the crypto_policy_t datatype. + * include more elements in the srtp_crypto_policy_t datatype. * * @warning This crypto policy is intended for use in SRTP, but not in * SRTCP. It is recommended that a policy that uses longer @@ -989,7 +989,7 @@ void srtp_crypto_policy_set_aes_cm_192_hmac_sha1_32(srtp_crypto_policy_t *p); * @param p is a pointer to the policy structure to be set * * The function call srtp_crypto_policy_set_aes_cm_192_null_auth(&p) sets - * the crypto_policy_t at location p to use the SRTP default cipher + * the srtp_crypto_policy_t at location p to use the SRTP default cipher * (AES-192 Counter Mode), but to use no authentication method. This * policy is NOT RECOMMENDED unless it is unavoidable; see Section 7.5 * of RFC 3711 (http://www.ietf.org/rfc/rfc3711.txt). @@ -998,7 +998,7 @@ void srtp_crypto_policy_set_aes_cm_192_hmac_sha1_32(srtp_crypto_policy_t *p); * with the policy data structure. You are encouraged to initialize * policy elements with this function call. Doing so may allow your * code to be forward compatible with later versions of libSRTP that - * include more elements in the crypto_policy_t datatype. + * include more elements in the srtp_crypto_policy_t datatype. * * @warning This policy is NOT RECOMMENDED for SRTP unless it is * unavoidable, and it is NOT RECOMMENDED at all for SRTCP; see |