start using const on internal arguments #665

pabuhler · 2023-12-16T23:18:20Z

Add const cast warnings.
Add const when the arguments do not need to be modified.

Add const cast warnings. Add const when the arguments do not need to be modified.

pabuhler · 2023-12-16T23:19:06Z

This lays the ground work for using const in more places

paulej · 2023-12-17T16:08:46Z

crypto/cipher/aes_gcm_nss.c

@@ -212,7 +212,9 @@ static srtp_err_status_t srtp_aes_gcm_nss_context_init(void *cv,
        return (srtp_err_status_cipher_fail);
    }

-    SECItem key_item = { siBuffer, (unsigned char *)key, c->key_size };
+    /* explicitly cast away const of key */
+    SECItem key_item = { siBuffer, (unsigned char *)(uintptr_t)key,


I think the compiler is whing too much if this is an issue.

paulej · 2023-12-17T16:09:14Z

crypto/cipher/aes_icm_nss.c

@@ -254,7 +254,9 @@ static srtp_err_status_t srtp_aes_icm_nss_context_init(void *cv,
        return srtp_err_status_bad_param;
    }

-    SECItem keyItem = { siBuffer, (unsigned char *)key, c->key_size };
+    /* explicitly cast away const of key */
+    SECItem keyItem = { siBuffer, (unsigned char *)(uintptr_t)key,


paulej · 2023-12-17T16:09:28Z

crypto/hash/hmac_nss.c

@@ -187,7 +187,8 @@ static srtp_err_status_t srtp_hmac_init(void *statev,
        return srtp_err_status_bad_param;
    }

-    SECItem key_item = { siBuffer, (unsigned char *)key, key_len };
+    /* explicitly cast away const of key */
+    SECItem key_item = { siBuffer, (unsigned char *)(uintptr_t)key, key_len };


paulej · 2023-12-17T16:10:52Z

srtp/srtp.c

-            (srtp_hdr_xtnd_t *)((uint32_t *)hdr + uint32s_in_rtp_header +
-                                hdr->cc);
+        const srtp_hdr_xtnd_t *xtn_hdr =
+            (const srtp_hdr_xtnd_t *)((const uint32_t *)hdr +


Pre-existing, but the double cast here is also a little surprising that it might be necessary. const additions good.

This is only because of the usage of uint32s_in_rtp_header, so needs needs the first cast to do the right pointer arithmetic. I have have another change coming that provides some helper functions for the hdr ext stuff as these cast are ugly and murmurous.

paulej · 2023-12-17T16:12:24Z

srtp/srtp.c

        int profile_len = ntohs(xtn_hdr->length);
        rtp_header_len += profile_len * 4;
        /* profile length counts the number of 32-bit words */
-        if (*pkt_octet_len < rtp_header_len)
+        if (pkt_octet_len < rtp_header_len)


Wow. I'm surprised the compiler did not complain about this one.

this was due to api change from int * to int

paulej · 2023-12-17T16:20:28Z

srtp/srtp.c

-            &mki_size);
+        session_keys =
+            srtp_get_session_keys(stream, (const uint8_t *)hdr,
+                                  (unsigned int)*pkt_octet_len, &mki_size);


While this cast might be necessary, why do we have a mix of signed and unsigned integer use? That might be a good thing to harmonize. I personally prefer unsigned integers for length values.

This is something we have been looking at and yes we need to harmonize on this and other types, it is coming :)
For length I would even go as far as using size_t every where including in the public api in v3!

This PR contains the following updates: | Package | Update | Change | |---|---|---| | [cisco/libsrtp](https://github.com/cisco/libsrtp) | minor | `v2.5.0` -> `v2.6.0` | --- ### Release Notes <details> <summary>cisco/libsrtp (cisco/libsrtp)</summary> ### [`v2.6.0`](https://github.com/cisco/libsrtp/releases/tag/v2.6.0): libSRTP 2.6.0 [Compare Source](cisco/libsrtp@v2.5.0...v2.6.0) #### What's Changed - cmake: Support configuring as subproject by [@yangskyboxlabs](https://github.com/yangskyboxlabs) in cisco/libsrtp#640 - cmake: Rename TEST_APPS as LIBSRTP_TEST_APPS option by [@yangskyboxlabs](https://github.com/yangskyboxlabs) in cisco/libsrtp#641 - Add a missing typedef for stream list ctx by [@Lastique](https://github.com/Lastique) in cisco/libsrtp#643 - Add x86 SIMD optimizations to crypto datatypes by [@Lastique](https://github.com/Lastique) in cisco/libsrtp#507 - fix typo by [@uniontech-lilinjie](https://github.com/uniontech-lilinjie) in cisco/libsrtp#648 - iv length is constant so set only once by [@pabuhler](https://github.com/pabuhler) in cisco/libsrtp#649 - Fix library version in Doxygen docs by [@Lastique](https://github.com/Lastique) in cisco/libsrtp#654 - remove comma from srtp_profile_t enum value. by [@melchi45](https://github.com/melchi45) in cisco/libsrtp#658 - meson.build: implement mbedtls support by [@iameli](https://github.com/iameli) in cisco/libsrtp#660 - remove travis reference from README.md by [@pabuhler](https://github.com/pabuhler) in cisco/libsrtp#661 - try to use ubuntu-latest by [@pabuhler](https://github.com/pabuhler) in cisco/libsrtp#664 - Some srtp_driver fixes by [@pabuhler](https://github.com/pabuhler) in cisco/libsrtp#662 - Some cipher_driver fixes by [@pabuhler](https://github.com/pabuhler) in cisco/libsrtp#663 - start using const on internal arguments by [@pabuhler](https://github.com/pabuhler) in cisco/libsrtp#665 - Cleaning up cmake and enabled more warnings. by [@palerikm](https://github.com/palerikm) in cisco/libsrtp#666 - fix line break in stream_list.yml by [@pabuhler](https://github.com/pabuhler) in cisco/libsrtp#668 - remove use of pointers to 32bit values by [@pabuhler](https://github.com/pabuhler) in cisco/libsrtp#667 #### New Contributors - [@yangskyboxlabs](https://github.com/yangskyboxlabs) made their first contribution in cisco/libsrtp#640 - [@uniontech-lilinjie](https://github.com/uniontech-lilinjie) made their first contribution in cisco/libsrtp#648 - [@melchi45](https://github.com/melchi45) made their first contribution in cisco/libsrtp#658 - [@iameli](https://github.com/iameli) made their first contribution in cisco/libsrtp#660 - [@palerikm](https://github.com/palerikm) made their first contribution in cisco/libsrtp#666 **Full Changelog**: cisco/libsrtp@v2.5.0...v2.6.0 </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] If you want to rebase/retry this PR, check this box --- This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).  Reviewed-on: https://git.walbeck.it/walbeck-it/docker-janus-gateway/pulls/132 Co-authored-by: renovate-bot <[email protected]> Co-committed-by: renovate-bot <[email protected]>

start using const on internal arguments

b96e52c

Add const cast warnings. Add const when the arguments do not need to be modified.

paulej approved these changes Dec 17, 2023

View reviewed changes

pabuhler merged commit 8f54f80 into cisco:main Dec 18, 2023
33 checks passed

pabuhler deleted the const-cast branch December 18, 2023 10:01

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

start using const on internal arguments #665

start using const on internal arguments #665

pabuhler commented Dec 16, 2023

pabuhler commented Dec 16, 2023

paulej Dec 17, 2023

paulej Dec 17, 2023

paulej Dec 17, 2023

paulej Dec 17, 2023

pabuhler Dec 17, 2023

paulej Dec 17, 2023

pabuhler Dec 17, 2023

paulej Dec 17, 2023

pabuhler Dec 17, 2023

start using const on internal arguments #665

start using const on internal arguments #665

Conversation

pabuhler commented Dec 16, 2023

pabuhler commented Dec 16, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment