res_pjsip: Redirect module and handling for MESSAGEs #1580

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Open

maximilianfridrich wants to merge 2 commits into asterisk:master from maximilianfridrich:pjsip_redirect_module

+890 −31

Contributor

maximilianfridrich commented Nov 7, 2025 •

edited

Loading

res_pjsip: Introduce redirect module for handling 3xx responses
This commit introduces a new redirect handling module that provides
infrastructure for following SIP 3xx redirect responses. The redirect
functionality respects the endpoint's redirect_method setting and only
follows redirects when set to 'uri_pjsip'. This infrastructure can be
used by any PJSIP module that needs to handle 3xx redirect responses.

res_pjsip_messaging: Add support for following 3xx redirects
This commit integrates the redirect module into res_pjsip_messaging
to enable following 3xx redirect responses for outgoing SIP MESSAGEs.

When redirect_method is set to 'uri_pjsip' on an endpoint, Asterisk
will now follow 3xx redirect responses for MESSAGEs, similar to how
it behaves for INVITE responses. For other redirect_method values (user,
uri_core), redirects are not followed for MESSAGEs, maintaining backward
compatibility.

Resolves: #1576

UserNote: When redirect_method is set to 'uri_pjsip' on a pjsip
endpoint, Asterisk will now follow 3xx redirect responses for MESSAGEs.

Contributor Author

maximilianfridrich commented Nov 7, 2025

cherry-pick-to: 20
cherry-pick-to: 22
cherry-pick-to: 23
multiple-commits: standalone
testsuite-test-pr: 117

github-actions bot added pr-submit-testing-in-progress pr-submit-tests-passed and removed pr-submit-testing-in-progress labels

github-actions bot commented Nov 7, 2025

Workflow PRCheck completed successfully

maximilianfridrich mentioned this pull request

channels/pjsip: Add tests for SIP MESSAGE redirect functionality asterisk/testsuite#117

Open

maximilianfridrich force-pushed the pjsip_redirect_module branch from 683e974 to 788d3d7 Compare

November 9, 2025 13:21

github-actions bot added pr-submit-testing-in-progress pr-submit-tests-passed and removed pr-submit-tests-passed pr-submit-testing-in-progress labels

github-actions bot commented Nov 9, 2025

Workflow PRCheck completed successfully

maximilianfridrich force-pushed the pjsip_redirect_module branch from 788d3d7 to f07f2e0 Compare

November 18, 2025 11:58

github-actions bot added pr-submit-testing-in-progress pr-submit-tests-passed and removed pr-submit-tests-passed pr-submit-testing-in-progress labels

github-actions bot commented Nov 18, 2025

Workflow PRCheck completed successfully

jcolp requested changes

View reviewed changes

include/asterisk/res_pjsip_redirect.h Outdated

    
              /*!

               * \brief Maximum size for a URI string

               */

              #define AST_SIP_MAX_URI_SIZE 512

Member

jcolp Nov 25, 2025

Is there a reason not to use the PJSIP defined one?

Contributor Author

maximilianfridrich Nov 25, 2025

I thought there was a PJSIP defined one but I couldn't find it. I found it now and will use it. Thanks.

include/asterisk/res_pjsip_redirect.h

    
              /*!

               * \brief Maximum number of redirect hops allowed

               */

              #define AST_SIP_MAX_REDIRECT_HOPS 5

Member

jcolp Nov 25, 2025

Where did 5 come from?

Contributor Author

maximilianfridrich Nov 25, 2025

Completely arbitrary. I thought this could be a sensible/safe "maximum".
Would you want it to be configurable, or something else?

Member

jcolp Nov 25, 2025

If it ever became an issue we could make it configurable, same for redirect contacts. Realistically I don't expect this will ever need to change or be touched - but was wondering if there was some source that needed to be documented as where the value came from.

include/asterisk/res_pjsip_redirect.h

    
              /*!

               * \brief Maximum number of redirect contacts to process

               */

              #define AST_SIP_MAX_REDIRECT_CONTACTS 20

Member

jcolp Nov 25, 2025

Where did 20 come from?

Contributor Author

maximilianfridrich Nov 25, 2025

Completely arbitrary. I just thought it could be good to have a maximum.

include/asterisk/res_pjsip_redirect.h Outdated

    
               * SIP 3xx redirects, including visited URIs for loop detection,

               * pending contacts for retry logic, and hop counting.

               */

              struct ast_sip_redirect_context;

Member

jcolp Nov 25, 2025

Context has a rather specific meaning within Asterisk, and I must admit on reading this name I thought it meant dialplan context and was confused until the brief description sunk in. I think a different name would eliminate that confusion. "ast_sip_redirect_state"

Contributor Author

maximilianfridrich Nov 25, 2025

Good point, thanks and sorry about the confusion. I'll rename everything to state.

include/asterisk/res_pjsip_redirect.h Outdated

    
               * \brief Check if redirect should be followed based on endpoint configuration

               *

               * \param endpoint The SIP endpoint

               * \param status_code The response status code

Member

jcolp Nov 25, 2025

The response status code from what?

Contributor Author

maximilianfridrich Nov 25, 2025

I clarified the doc comment: "The status code from a SIP response message (e.g. 305)"

res/res_pjsip/redirect.c

    
              		return 1.0f;

              	}

              	/* Parse the q value */

Member

jcolp Nov 25, 2025

We're on our second implementation of this with the other being in security_agreements.c - if possible I think a common parsing function in res_pjsip.c would be good

Contributor Author

maximilianfridrich Nov 25, 2025

Right, thanks. Sorry about the duplication. I moved the conversion from string to float to res_pjsip.c.

res/res_pjsip/redirect.c Outdated

    
               * \param contacts List to populate with parsed contacts

               * \return Number of valid contacts found

               */

              static int parse_redirect_contacts(pjsip_rx_data *rdata, struct redirect_contact_list *contacts)

Member

jcolp Nov 25, 2025

Pass in the state/context pointer, and use the endpoint to add name to the logging

I'm kind of a broken record lately with logging, but giving information on which endpoint is involved can be very valuable if someone goes back to try to understand what happened on a well used system

The same applies for the code going forward after this comment, I'm not going to comment on each one but I urge you to go back to each and try to make them more specific/detailed including endpoint name

Contributor Author

maximilianfridrich Nov 25, 2025

Understood. I tried to add the endpoint ID to the logs (mostly within the prose). Let me know if this is okay or if you would like it differently (e.g. a consistent format).

res/res_pjsip/redirect.c Outdated

    
              		return -1;

              	}

              	ast_log(LOG_NOTICE, "Redirect: found %d Contact header%s\n", contact_count, contact_count == 1 ? "" : "s");

Member

jcolp Nov 25, 2025

This should be removed

Contributor Author

maximilianfridrich Nov 25, 2025

Yes. Done.

res/res_pjsip_messaging.c Outdated

    
              {

              	struct message_response_data *resp_data;

              	resp_data = ao2_alloc(sizeof(*resp_data), message_response_data_destroy);

Member

jcolp Nov 25, 2025

This can be allocated without a lock using ao2_alloc_options

Contributor Author

maximilianfridrich Nov 25, 2025

Thanks. Done.

res/res_pjsip_messaging.c Outdated

    
              	struct msg_data *mdata = data; /* The caller holds a reference */

              	/* Callback data for redirect handling */

              	struct message_response_data *resp_data;

              	char content_type_buf[128];

Member

jcolp Nov 25, 2025

Where did 128 come from?

Contributor Author

maximilianfridrich Nov 25, 2025

Arbitrary. I thought that should be enough for the Content-Type header which contains a MIME type (potentially with parameters). I changed it now to a malloced ast_str which can grow if needed.

maximilianfridrich added 2 commits

November 25, 2025 14:21


          res_pjsip: Introduce redirect module for handling 3xx responses

f7fc091

This commit introduces a new redirect handling module that provides
infrastructure for following SIP 3xx redirect responses. The redirect
functionality respects the endpoint's redirect_method setting and only
follows redirects when set to 'uri_pjsip'. This infrastructure can be
used by any PJSIP module that needs to handle 3xx redirect responses.


          res_pjsip_messaging: Add support for following 3xx redirects

cd6d080

This commit integrates the redirect module into res_pjsip_messaging
to enable following 3xx redirect responses for outgoing SIP MESSAGEs.

When redirect_method is set to 'uri_pjsip' on an endpoint, Asterisk
will now follow 3xx redirect responses for MESSAGEs, similar to how
it behaves for INVITE responses. For other redirect_method values (user,
uri_core), redirects are not followed for MESSAGEs, maintaining backward
compatibility.

Resolves: asterisk#1576

UserNote: When redirect_method is set to 'uri_pjsip' on a pjsip
endpoint, Asterisk will now follow 3xx redirect responses for MESSAGEs.

maximilianfridrich force-pushed the pjsip_redirect_module branch from f07f2e0 to cd6d080 Compare

November 25, 2025 13:21

github-actions bot added pr-submit-testing-in-progress and removed pr-submit-tests-passed labels

Contributor Author

maximilianfridrich commented Nov 25, 2025

Thanks for the review @jcolp! I've incorporated your feedback and responded to your comments. Let me know what you think.

github-actions bot added pr-submit-tests-passed and removed pr-submit-testing-in-progress labels

github-actions bot commented Nov 25, 2025

Workflow PRCheck completed successfully

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

pr-submit-tests-passed