asterisk/doc/UPGRADE-staging
Ben Ford 1031a1805b STIR/SHAKEN: Option split and response codes.
The stir_shaken configuration option now has 4 different choices to pick
from: off, attest, verify, and on. Off and on behave the same way they
do now. Attest will only perform attestation on the endpoint, and verify
will only perform verification on the endpoint.

Certain responses are required to be sent based on certain conditions
for STIR/SHAKEN. For example, if we get a Date header that is outside of
the time range that is considered valid, a 403 Stale Date response
should be sent. This and several other responses have been added.

Change-Id: I4ac1ecf652cd0e336006b0ca638dc826b5b1ebf7
2021-10-27 08:39:56 -05:00
..
README.md doc: Fix CHANGES entries to have .txt suffix and update READMEs 2020-02-07 14:08:39 -06:00
app_dahdiras_removal.txt app_dahdiras: Remove deprecated module. 2021-08-17 10:35:38 -03:00
app_fax_removal.txt app_fax: Remove deprecated module. 2021-08-17 10:35:28 -03:00
app_ices_removal.txt app_ices: Remove deprecated module. 2021-08-17 10:35:23 -03:00
app_image_removal.txt app_image: Remove deprecated module. 2021-08-17 10:35:32 -03:00
app_meetme_deprecation.txt policy: Deprecate modules and add versions to others. 2021-08-11 08:14:51 -05:00
app_mysql_removal.txt app_mysql: Remove deprecated module. 2021-08-17 10:35:14 -03:00
app_nbscat_removal.txt app_nbscat: Remove deprecated module. 2021-08-17 10:35:36 -03:00
app_osplookup_deprecation.txt policy: Deprecate modules and add versions to others. 2021-08-11 08:14:51 -05:00
app_url_removal.txt app_url: Remove deprecated module. 2021-08-17 10:35:30 -03:00
cdr_mysql_removal.txt cdr_mysql: Remove deprecated module. 2021-08-17 10:34:34 -03:00
cdr_syslog_removal.txt cdr_syslog: Remove deprecated module. 2021-08-17 10:35:41 -03:00
chan_alsa_deprecation.txt policy: Deprecate modules and add versions to others. 2021-08-11 08:14:51 -05:00
chan_iax2_rsa.txt chan_iax2: Add encryption for RSA authentication 2021-10-07 18:23:48 -05:00
chan_mgcp_deprecation.txt policy: Deprecate modules and add versions to others. 2021-08-11 08:14:51 -05:00
chan_misdn_removal.txt chan_misdn: Remove deprecated module. 2021-08-17 10:37:40 -03:00
chan_nbs_removal.txt chan_nbs: Remove deprecated module. 2021-08-17 10:36:19 -03:00
chan_oss_removal.txt chan_oss: Remove deprecated module. 2021-08-17 10:35:43 -03:00
chan_phone_removal.txt chan_phone: Remove deprecated module. 2021-08-17 10:36:11 -03:00
chan_skinny_deprecation.txt policy: Deprecate modules and add versions to others. 2021-08-11 08:14:51 -05:00
chan_vpb_removal.txt chan_vpb: Remove deprecated module. 2021-08-17 10:38:05 -03:00
conf2ael_removal.txt conf2ael: Remove deprecated application. 2021-08-17 10:38:46 -03:00
http-media-cache-lookup-order.txt res_http_media_cache: Cleanup audio format lookup in HTTP requests 2021-08-02 13:21:13 -05:00
muted_removal.txt muted: Remove deprecated application. 2021-08-17 10:39:08 -03:00
res_config_sqlite_removal.txt res_config_sqlite: Remove deprecated module. 2021-08-17 10:38:34 -03:00
res_monitor_disabled.txt res_monitor: Disable building by default. 2021-08-18 11:15:11 -05:00
res_pktccops_deprecation.txt policy: Deprecate modules and add versions to others. 2021-08-11 08:14:51 -05:00
stir_shaken_option_split.txt STIR/SHAKEN: Option split and response codes. 2021-10-27 08:39:56 -05:00

README.md

DO NOT REMOVE THIS FILE!

The only files that should be added to this directory are ones that will be used by the release script to update the UPGRADE.txt file automatically. The only time that it is necessary to add something to the UPGRADE-staging directory is if you are making a breaking change to an existing feature in Asterisk. The file does not need to have a meaningful name, but it probably should. If there are multiple items that need documenting, you can add multiple files, each with their own description. If the message is going to be the same for each subject, then you can add multiple subject headers to one file. The "Subject: xxx" line is case sensitive! For example, if you are making a change to PJSIP, then you might add the file "res_pjsip_my_cool_feature.txt" to this directory, with a short description of what it does. The files must have the ".txt" suffix. If you are adding multiple entries, they should be done in the same commit to avoid merge conflicts. Here's an example:

Subject: res_pjsip Subject: Core

Here's a pretty good description of my new feature that explains exactly what it does and how to use it.

Here's a master-only example:

Subject: res_ari Master-Only: True

This change will only go into the master branch. The "Master-Only" header will never be in a change not in master.

Note that the second subject has another header: "Master-Only". Changes that go into the master branch and ONLY the master branch are the only ones that should have this header. Also, the value can only be "true" or "True". The "Master-Only" part of the header IS case-sensitive, however!

For more information, check out the wiki page: https://wiki.asterisk.org/wiki/display/AST/CHANGES+and+UPGRADE.txt