docs: security acknowledgement #15387

lucasgonze · 2024-02-29T20:54:01Z

Summary

Add researcher Nathaniel Bennett to security acknowledgements in README.

Test Plan

No breakage possible.

Additional Information

This change is backwards-breaking

Security Considerations

Benefits security by encouraging future research and disclosures.

github-actions · 2024-02-29T20:54:14Z

Thanks for opening a PR! 💯

A couple initial guidelines

All commits must be signed off. This is enforced by PR DCO check.
All PR titles must follow the semantic commits format. This is enforced by PR Check Title Or Commit Message.

Howto

Reviews. The "Reviewers" listed for this PR are the Magma maintainers who will shepherd it.
Checks. All required CI checks must pass before merge.
Merge. Once approved and passing CI checks, use the ready2merge label to indicate the maintainers can merge your PR.

More info

Please take a moment to read through the Magma project's

Contributing Conventions for norms around contributed code

If this is your first Magma PR, also consider reading

Developer Onboarding for onboarding as a new Magma developer
Development Workflow for guidance on your first PR
CI Checks for points of contact for failing or flaky CI checks
Code Review Process for information on requesting reviews and contacting maintainers

github-actions · 2024-02-29T20:54:35Z

third_party/gtp_ovs/ovs-gtp-patches/2.15/dev.sh

 }


 function  build_test() {
  service magma@* stop
+  # sometimes this package is auto removed.
+
+  apt install -y linux-modules-extra-`uname -r`


⚠️ [shellcheck] _{reported by reviewdog 🐶}
Quote this to prevent word splitting. SC2046

github-actions · 2024-02-29T20:54:35Z

third_party/gtp_ovs/ovs-gtp-patches/2.15/dev.sh

 }


 function  build_test() {
  service magma@* stop
+  # sometimes this package is auto removed.
+
+  apt install -y linux-modules-extra-`uname -r`


[shellcheck] _{reported by reviewdog 🐶}
Use $(...) notation instead of legacy backticks .... SC2006

github-actions · 2024-02-29T20:54:35Z

third_party/build/bin/aioh2_build.sh

+
+set -e
+SCRIPT_DIR="$(dirname "$(realpath "$0")")"
+source "$SCRIPT_DIR"/../lib/util.sh


📝 [shellcheck] _{reported by reviewdog 🐶}
Not following: ./../lib/util.sh: openBinaryFile: does not exist (No such file or directory) SC1091

github-actions · 2024-02-29T20:54:35Z

third_party/build/bin/aioh2_build.sh

+# Create python virtual env to install python3 packages that do not work with apt
+python3 -m venv env
+VENV_DIR=$(pwd)/env
+source env/bin/activate


📝 [shellcheck] _{reported by reviewdog 🐶}
Not following: env/bin/activate: openBinaryFile: does not exist (No such file or directory) SC1091

github-actions · 2024-02-29T20:54:35Z

nms/e2e_test_setup.sh


 i=0
 while [ $i -lt 60 ]
 do
-    val=$(docker-compose -f docker-compose-e2e.yml logs magmalte 2>&1 | grep 'Production server started on port 8081' | wc -l)
+    val=$(docker compose -f docker-compose-e2e.yml logs magmalte 2>&1 | grep 'Production server started on port 8081' | wc -l)


[shellcheck] _{reported by reviewdog 🐶}
Consider using grep -c instead of grep|wc -l. SC2126

github-actions · 2024-02-29T20:54:35Z

.devcontainer/post-create-commands.sh

 echo "Generating compile_commands.json for C/C++ code navigation"
 "$1"/dev_tools/gen_compilation_database.py
+
+echo "Setting up Bazel Bash completion"
+"$1"/bazel/scripts/setup_bazel_bash_completion.sh $(cat "$1"/.bazelversion)


⚠️ [shellcheck] _{reported by reviewdog 🐶}
Quote this to prevent word splitting. SC2046

github-actions

Remaining comments which cannot be posted as a review comment to avoid GitHub Rate Limit

hadolint

github-actions · 2024-02-29T20:54:33Z

.devcontainer/Dockerfile

        python3-aioeventlet

 ##### libgtpnl
 # review https://github.com/OPENAIRINTERFACE/openair-cn/blob/master/build/tools/build_helper.gtpnl
-RUN git clone https://git.osmocom.org/libgtpnl && \
+RUN git clone https://gitea.osmocom.org/cellular-infrastructure/libgtpnl && \


⚠️ [hadolint] <DL3003> _{reported by reviewdog 🐶}
Use WORKDIR to switch to a directory

github-actions · 2024-02-29T20:54:33Z

.devcontainer/bazel-base/Dockerfile

-    add-apt-repository 'deb https://artifactory.magmacore.org/artifactory/debian-test focal-ci main' && \
-    add-apt-repository 'deb https://artifactory.magmacore.org/artifactory/debian-test focal-1.7.0 main' && \
+COPY keys/linux_foundation_registry_key.asc /etc/apt/trusted.gpg.d/magma.asc
+RUN add-apt-repository 'deb https://linuxfoundation.jfrog.io/artifactory/magma-packages-test focal-ci main' && \


📝 [hadolint] <DL3009> _{reported by reviewdog 🐶}
Delete the apt-get lists after installing something

github-actions · 2024-02-29T20:54:34Z

.devcontainer/bazel-base/Dockerfile

-    add-apt-repository 'deb https://artifactory.magmacore.org/artifactory/debian-test focal-ci main' && \
-    add-apt-repository 'deb https://artifactory.magmacore.org/artifactory/debian-test focal-1.7.0 main' && \
+COPY keys/linux_foundation_registry_key.asc /etc/apt/trusted.gpg.d/magma.asc
+RUN add-apt-repository 'deb https://linuxfoundation.jfrog.io/artifactory/magma-packages-test focal-ci main' && \


⚠️ [hadolint] <DL3008> _{reported by reviewdog 🐶}
Pin versions in apt get install. Instead of apt-get install <package> use apt-get install <package>=<version>

github-actions · 2024-02-29T20:54:34Z

.devcontainer/bazel-base/Dockerfile

@@ -98,4 +112,7 @@
 RUN ln -s /workspaces/magma/.bazel-cache /var/cache/bazel-cache
 RUN ln -s /workspaces/magma/.bazel-cache-repo /var/cache/bazel-cache-repo

+# Convenience alias to build AGW services
+RUN echo 'alias magma-build-agw="bazel build //... --build_tag_filters=service,util_script,-mme_oai"' >> ~/.bashrc


📝 [hadolint] <DL3059> _{reported by reviewdog 🐶}
Multiple consecutive RUN instructions. Consider consolidation.

github-actions · 2024-02-29T20:54:34Z

ci-scripts/docker/Dockerfile.mme.ci.ubuntu18

@@ -15,13 +26,15 @@ RUN rm -Rf $MAGMA_ROOT $C_BUILD && mkdir -p $C_BUILD
 COPY ./ $MAGMA_ROOT

 # Build MME executables
-RUN cd $MAGMA_ROOT/lte/gateway && \
+RUN cd $MAGMA_ROOT && \


⚠️ [hadolint] <DL3003> _{reported by reviewdog 🐶}
Use WORKDIR to switch to a directory

github-actions · 2024-02-29T20:54:39Z

lte/gateway/docker/mme/Dockerfile.ubuntu18.04

+    cd .. && rm -R --interactive=never _build
+
+##### NETTLE / gnutls
+RUN tar -xf nettle-2.5.tar.gz && \


⚠️ [hadolint] <SC2069> _{reported by reviewdog 🐶}
To redirect stdout+stderr, 2>&1 must be last (or use '{ cmd > file; } 2>&1' to clarify).

github-actions · 2024-02-29T20:54:39Z

lte/gateway/docker/mme/Dockerfile.ubuntu18.04


 ##### liblfds
 # https://www.liblfds.org/mediawiki/index.php?title=r7.1.0:Building_Guide_(liblfds)
-RUN git clone https://github.com/liblfds/liblfds.git && \
-    cd liblfds/liblfds/liblfds7.1.0/liblfds710/build/gcc_gnumake/ && \
+RUN cd /liblfds/liblfds/liblfds7.1.0/liblfds710/build/gcc_gnumake/ && \


⚠️ [hadolint] <DL3003> _{reported by reviewdog 🐶}
Use WORKDIR to switch to a directory

github-actions · 2024-02-29T20:54:39Z

lte/gateway/docker/mme/Dockerfile.ubuntu18.04


 ##### liblfds
 # https://www.liblfds.org/mediawiki/index.php?title=r7.1.0:Building_Guide_(liblfds)
-RUN git clone https://github.com/liblfds/liblfds.git && \
-    cd liblfds/liblfds/liblfds7.1.0/liblfds710/build/gcc_gnumake/ && \
+RUN cd /liblfds/liblfds/liblfds7.1.0/liblfds710/build/gcc_gnumake/ && \


[hadolint] <SC2006> _{reported by reviewdog 🐶}
Use $(...) notation instead of legacy backticks ....

github-actions · 2024-02-29T20:54:39Z

lte/gateway/docker/mme/Dockerfile.ubuntu18.04


 ##### libgtpnl
 # review https://github.com/OPENAIRINTERFACE/openair-cn/blob/master/build/tools/build_helper.gtpnl
-RUN git clone https://git.osmocom.org/libgtpnl && \
-    cd libgtpnl && \
+RUN cd libgtpnl && \


⚠️ [hadolint] <DL3003> _{reported by reviewdog 🐶}
Use WORKDIR to switch to a directory

github-actions · 2024-02-29T20:54:39Z

lte/gateway/docker/mme/Dockerfile.ubuntu18.04


 ##### libgtpnl
 # review https://github.com/OPENAIRINTERFACE/openair-cn/blob/master/build/tools/build_helper.gtpnl
-RUN git clone https://git.osmocom.org/libgtpnl && \
-    cd libgtpnl && \
+RUN cd libgtpnl && \


⚠️ [hadolint] <SC2069> _{reported by reviewdog 🐶}
To redirect stdout+stderr, 2>&1 must be last (or use '{ cmd > file; } 2>&1' to clarify).

github-actions · 2024-02-29T20:54:42Z

BUILD.bazel

+)
+
+alias(
+    name = "monitord",


[misspell] _{reported by reviewdog 🐶}
"monitord" is a misspelling of "monitored"

github-actions · 2024-02-29T20:54:42Z

lte/gateway/python/BUILD.bazel

+pkg_filegroup(
+    name = "cwf_lte_python_services",
+    srcs = ["{py_service}_expanded".format(py_service = py_service) for py_service in [
+        "monitord",


[misspell] _{reported by reviewdog 🐶}
"monitord" is a misspelling of "monitored"

github-actions · 2024-02-29T20:54:43Z

lte/gateway/c/core/oai/tasks/grpc_service/AmfServiceImpl.cpp

+  memset(&itti_msg, 0, sizeof(itti_n11_create_pdu_session_response_t));
+
+  if (SetSmfSessionContext_itti(request, &itti_msg) == false) {
+    return Status::CANCELLED;


[misspell] _{reported by reviewdog 🐶}
"CANCELLED" is a misspelling of "CANCELED"

github-actions · 2024-02-29T20:54:43Z

lte/gateway/c/core/oai/test/spgw_task/test_pgw_pco.cpp

-  pco_req.protocol_or_container_ids[0].id =
-      PCO_CI_IP_ADDRESS_ALLOCATION_VIA_NAS_SIGNALLING;
+  magma::lte::oai::PcoProtocol* pco_protocol = pco_req.add_pco_protocol();
+  pco_protocol->set_id(PCO_CI_IP_ADDRESS_ALLOCATION_VIA_NAS_SIGNALLING);


[misspell] _{reported by reviewdog 🐶}
"SIGNALLING" is a misspelling of "SIGNALING"

github-actions · 2024-02-29T20:54:43Z

docs/docusaurus/versioned_docs/version-1.8.0/nms/metrics.md

+|enforcement_stats_rule_install_fail |Counts number of times rule install failed in enforcement stats app |AGW |pipelined |
+|network_iface_status |Status of a network interface required for data pipeline |AGW |pipelined |
+| | | | |
+|subscriber_icmp_latency_ms |Reported latency for subscriber in milliseconds |AGW |monitord |


[misspell] _{reported by reviewdog 🐶}
"monitord" is a misspelling of "monitored"

github-actions · 2024-02-29T20:54:43Z

orc8r/gateway/go/services/magmad/README.md

+- Bootstraping gateway on the network and maintaining gateway's client certificates
+- Checking in with the cloud and providing the cloud with up to date gateway status
+- Monitoring gateway services, collecting and publishing the services' and system metrics to the cloud
+- Creating and maintaining secure cloud to gateway RPC channel for real time cloud requests fulfilment


[misspell] _{reported by reviewdog 🐶}
"fulfilment" is a misspelling of "fulfillment"

github-actions

Remaining comments which cannot be posted as a review comment to avoid GitHub Rate Limit

markdownlint

docs/readmes/orc8r/deploy_using_ansible.md|18 col 44| MD009/no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1]
docs/readmes/orc8r/deploy_using_ansible.md|27| MD040/fenced-code-language Fenced code blocks should have a language specified [Context: ""] [docs/readmes/orc8r/deploy_using_ansible.md|33|](https://github.com/magma/magma/blob/205b5143008dc24b104b23995baba09531d44725/docs/readmes/orc8r/deploy_using_ansible.md#L33) MD040/fenced-code-language Fenced code blocks should have a language specified [Context: ""]
docs/readmes/orc8r/deploy_using_ansible.md|56| MD040/fenced-code-language Fenced code blocks should have a language specified [Context: ""] [docs/readmes/orc8r/deploy_using_ansible.md|62|](https://github.com/magma/magma/blob/205b5143008dc24b104b23995baba09531d44725/docs/readmes/orc8r/deploy_using_ansible.md#L62) MD040/fenced-code-language Fenced code blocks should have a language specified [Context: ""]
docs/readmes/orc8r/deploy_using_ansible.md|66| MD040/fenced-code-language Fenced code blocks should have a language specified [Context: ""] [docs/readmes/orc8r/deploy_using_ansible.md|115|](https://github.com/magma/magma/blob/205b5143008dc24b104b23995baba09531d44725/docs/readmes/orc8r/deploy_using_ansible.md#L115) MD040/fenced-code-language Fenced code blocks should have a language specified [Context: ""]
docs/readmes/orc8r/deploy_using_ansible.md|124| MD040/fenced-code-language Fenced code blocks should have a language specified [Context: ""] [docs/readmes/orc8r/deploy_using_ansible.md|128|](https://github.com/magma/magma/blob/205b5143008dc24b104b23995baba09531d44725/docs/readmes/orc8r/deploy_using_ansible.md#L128) MD040/fenced-code-language Fenced code blocks should have a language specified [Context: ""]
docs/readmes/orc8r/deploy_using_ansible.md|135| MD040/fenced-code-language Fenced code blocks should have a language specified [Context: ""] [docs/readmes/orc8r/deploy_using_ansible.md|147 col 1|](https://github.com/magma/magma/blob/205b5143008dc24b104b23995baba09531d44725/docs/readmes/orc8r/deploy_using_ansible.md#L147) MD034/no-bare-urls Bare URL used [Context: "https://magma-test.nms.magma.l..."] [docs/readmes/orc8r/deploy_using_ansible.md|149|](https://github.com/magma/magma/blob/205b5143008dc24b104b23995baba09531d44725/docs/readmes/orc8r/deploy_using_ansible.md#L149) MD012/no-multiple-blanks Multiple consecutive blank lines [Expected: 1; Actual: 2] [docs/readmes/orc8r/deploy_using_ansible.md|154|](https://github.com/magma/magma/blob/205b5143008dc24b104b23995baba09531d44725/docs/readmes/orc8r/deploy_using_ansible.md#L154) MD040/fenced-code-language Fenced code blocks should have a language specified [Context: ""]
docs/readmes/orc8r/deploy_using_ansible.md|160| MD040/fenced-code-language Fenced code blocks should have a language specified [Context: ""] [docs/readmes/orc8r/deploy_using_ansible.md|173|](https://github.com/magma/magma/blob/205b5143008dc24b104b23995baba09531d44725/docs/readmes/orc8r/deploy_using_ansible.md#L173) MD040/fenced-code-language Fenced code blocks should have a language specified [Context: ""]
dp/tools/performance_tests/README.md|26| MD001/heading-increment/header-increment Heading levels should only increment by one level at a time [Expected: h3; Actual: h4]
experimental/cloudstrapper/README.md|285 col 54| MD033/no-inline-html Inline HTML [Element: dirInenvtory]
experimental/cloudstrapper/README.md|378 col 42| MD033/no-inline-html Inline HTML [Element: Local]
feg/gateway/helm/feg-kubevirt/README.md|52 col 1| MD029/ol-prefix Ordered list item prefix [Expected: 2; Actual: 5; Style: 1/2/3]
feg/gateway/helm/feg-kubevirt/README.md|134| MD001/heading-increment/header-increment Heading levels should only increment by one level at a time [Expected: h3; Actual: h4]
feg/gateway/helm/feg-virtlet/README.md|126| MD001/heading-increment/header-increment Heading levels should only increment by one level at a time [Expected: h3; Actual: h4]
feg/gateway/helm/feg-virtlet/README.md|150 col 1| MD029/ol-prefix Ordered list item prefix [Expected: 1; Actual: 2; Style: 1/1/1]
hil_testing/README.md|167| MD003/heading-style/header-style Heading style [Expected: atx; Actual: atx_closed]
hil_testing/spirent_automation/TC/Testplan.md|183| MD036/no-emphasis-as-heading/no-emphasis-as-header Emphasis used instead of a heading [Context: "Validation Categories -"]
lte/gateway/deploy/agwc-helm-charts/README.md|44| MD025/single-title/single-h1 Multiple top-level headings in the same document [Context: "# Delete the AGW if needed usi..."]
README.md|10 col 5| MD033/no-inline-html Inline HTML [Element: a]
README.md|10 col 69| MD033/no-inline-html Inline HTML [Element: img]
SECURITY.md|39 col 1| MD029/ol-prefix Ordered list item prefix [Expected: 4; Actual: 3; Style: 1/2/3]
SECURITY.md|41 col 1| MD029/ol-prefix Ordered list item prefix [Expected: 5; Actual: 4; Style: 1/2/3]
SECURITY.md|43 col 1| MD029/ol-prefix Ordered list item prefix [Expected: 6; Actual: 5; Style: 1/2/3]
SECURITY.md|49 col 1| MD029/ol-prefix Ordered list item prefix [Expected: 7; Actual: 6; Style: 1/2/3]
show-tech/README.md|1| MD002/first-heading-h1/first-header-h1 First heading should be a top-level heading [Expected: h1; Actual: h2]
show-tech/README.md|1| MD041/first-line-heading/first-line-h1 First line in a file should be a top-level heading [Context: "## Prereq"]

github-actions · 2024-02-29T20:54:52Z

CONTRIBUTING.md

+        1. If a TSC member is inactive, the other TSC members have the authority to vote the inactive member off the TSC with a two thirds vote.
+        2. In the case that a TSC member resigns or is removed, a special election to fill the open seat would occur following the same election process outlined in section 3.
+    3.There will be an annual election to determine the composition of the TSC.
+    4. Employees from the same organization/company should not hold more than one TSC seat.


[markdownlint] _{reported by reviewdog 🐶}
MD029/ol-prefix Ordered list item prefix [Expected: 3; Actual: 4; Style: 1/2/3]

github-actions · 2024-02-29T20:54:53Z

cwf/gateway/helm/cwf-kubevirt/README.md

-
-    #### Creating Gateway Info
+
+#### Creating Gateway Info


[markdownlint] _{reported by reviewdog 🐶}
MD001/heading-increment/header-increment Heading levels should only increment by one level at a time [Expected: h3; Actual: h4]

github-actions · 2024-02-29T20:54:53Z

cwf/gateway/helm/cwf-virtlet/README.md

-
-    #### Creating Gateway Info
+
+#### Creating Gateway Info


[markdownlint] _{reported by reviewdog 🐶}
MD001/heading-increment/header-increment Heading levels should only increment by one level at a time [Expected: h3; Actual: h4]

github-actions · 2024-02-29T20:54:53Z

docs/docusaurus/versioned_docs/version-1.0.0/feg/legacy/README.md


 ## Federated Gateway Services & Tools

 The following services run on the federated gateway:
- - `s6a_proxy` - translates calls from GRPC to S6a protocol between AGW and HSS 
+ - `s6a_proxy` - translates calls from GRPC to S6a protocol between AGW and HSS


[markdownlint] _{reported by reviewdog 🐶}
MD006/ul-start-left Consider starting bulleted lists at the beginning of the line [Expected: 0; Actual: 1]

github-actions · 2024-02-29T20:54:53Z

docs/docusaurus/versioned_docs/version-1.0.0/feg/legacy/README.md


 ## Federated Gateway Services & Tools

 The following services run on the federated gateway:
- - `s6a_proxy` - translates calls from GRPC to S6a protocol between AGW and HSS 
+ - `s6a_proxy` - translates calls from GRPC to S6a protocol between AGW and HSS


[markdownlint] _{reported by reviewdog 🐶}
MD007/ul-indent Unordered list indentation [Expected: 0; Actual: 1]

github-actions · 2024-02-29T20:54:57Z

docs/docusaurus/versioned_docs/version-1.6.X/nms/alerts_troubleshooting.md

 3. Perform relevant sync/changes if any update has been performed on NMS -> Network.
-4. Make sure that configuration for [Gateway](https://docs.magmacore.org/docs/lte/deploy_config_agw), [eNodeB](https://docs.magmacore.org/docs/lte/deploy_config_enodebd) and [APN ](https://docs.magmacore.org/docs/lte/deploy_config_apn)has been followed.
+4. Make sure that configuration for [Gateway](https://magma.github.io/magma/docs/lte/deploy_config_agw), [eNodeB](https://magma.github.io/magma/docs/lte/deploy_config_enodebd) and [APN ](https://magma.github.io/magma/docs/lte/deploy_config_apn)has been followed.


[markdownlint] _{reported by reviewdog 🐶}
MD039/no-space-in-links Spaces inside link text [Context: "[APN ]"]

github-actions · 2024-02-29T20:54:57Z

docs/docusaurus/versioned_docs/version-1.6.X/nms/alerts_troubleshooting.md

@@ -78,13 +78,13 @@
 ### Troubleshooting steps

 1. Perform relevant sync/changes if any update has been performed on NMS -> Network.
-2. Make sure that configuration for [Gateway](https://docs.magmacore.org/docs/lte/deploy_config_agw), [eNodeB](https://docs.magmacore.org/docs/lte/deploy_config_enodebd) and [APN ](https://docs.magmacore.org/docs/lte/deploy_config_apn)has been followed.
-3. Please follow troubleshooting steps from [here](https://docs.magmacore.org/docs/howtos/troubleshooting/user_unable_to_attach) for issue Gateway. Please note the error code.
+2. Make sure that configuration for [Gateway](https://magma.github.io/magma/docs/lte/deploy_config_agw), [eNodeB](https://magma.github.io/magma/docs/lte/deploy_config_enodebd) and [APN ](https://magma.github.io/magma/docs/lte/deploy_config_apn)has been followed.


[markdownlint] _{reported by reviewdog 🐶}
MD039/no-space-in-links Spaces inside link text [Context: "[APN ]"]

github-actions · 2024-02-29T20:54:58Z

docs/docusaurus/versioned_docs/version-1.6.X/nms/metrics.md

@@ -35,8 +35,8 @@ With Grafana, you can create your own custom dashboards and populate them with a
 The simple way is to just click on the “+” icon on the left sidebar, then create a new dashboard. There is ample documentation about grafana dashboards online if you need help creating your dashboard.

 ![Grafana new dashboard](assets/nms/grafana_new_dashboard.png)
- Grafana documentation on creating dashboards: [Grafana Dashboards](_https://grafana.com/docs/grafana/latest/features/dashboard/dashboards/_)
- Prometheus documentation on writing queries: [Prometheus Querying](_https://prometheus.io/docs/prometheus/latest/querying/basics/_)
+- Grafana documentation on creating dashboards: [Grafana Dashboards](https://grafana.com/docs/grafana/latest/features/dashboard/dashboards/)


[markdownlint] _{reported by reviewdog 🐶}
MD032/blanks-around-lists Lists should be surrounded by blank lines [Context: "- Grafana documentation on cre..."]

github-actions · 2024-02-29T20:54:58Z

docs/docusaurus/versioned_docs/version-1.6.X/proposals/p017_apn_refactoring.md

@@ -154,4 +154,4 @@ We have two options to implement this, we will choose it depending on time in 1.
 ## **References**

 * https://gist.github.com/karthiksubraveti/0daee7f5446cc72460497e247d427ee6
-* _https://raw.githubusercontent.com/magma/magma/d691319dd40e0a7d2822a993f819beca7490e65d/docs/readmes/lte/Attach_call_flow_in_Magma.txt_
+* [_https://raw.githubusercontent.com/magma/magma/d691319dd40e0a7d2822a993f819beca7490e65d/docs/readmes/lte/Attach_call_flow_in_Magma.txt_](https://raw.githubusercontent.com/magma/magma/d691319dd40e0a7d2822a993f819beca7490e65d/docs/readmes/lte/Attach_call_flow_in_Magma.txt)


[markdownlint] _{reported by reviewdog 🐶}
MD004/ul-style Unordered list style [Expected: dash; Actual: asterisk]

github-actions · 2024-02-29T20:54:58Z

docs/readmes/orc8r/deploy_using_ansible.md

+
+# Deploy Orchestrator using Ansible (Beta)
+
+This how-to guide can be used to deploy Magma's Orchestrator on any cloud environment. 


[markdownlint] _{reported by reviewdog 🐶}
MD009/no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1]

github-actions

Remaining comments which cannot be posted as a review comment to avoid GitHub Rate Limit

markdownlint-fix

docs/docusaurus/versioned_docs/version-1.6.X/lte/dev_notes.md|118|
docs/docusaurus/versioned_docs/version-1.6.X/lte/dev_notes.md|126|
docs/docusaurus/versioned_docs/version-1.6.X/lte/dev_notes.md|129|
docs/docusaurus/versioned_docs/version-1.6.X/nms/alerts_troubleshooting.md|34|
docs/docusaurus/versioned_docs/version-1.6.X/nms/alerts_troubleshooting.md|81|
docs/docusaurus/versioned_docs/version-1.6.X/nms/metrics.md|38 col 1|
docs/docusaurus/versioned_docs/version-1.6.X/proposals/p017_apn_refactoring.md|156|
docs/readmes/orc8r/deploy_using_ansible.md|9|
docs/readmes/orc8r/deploy_using_ansible.md|18|
docs/readmes/orc8r/deploy_using_ansible.md|147|

github-actions · 2024-02-29T20:55:18Z

docs/docusaurus/versioned_docs/version-1.0.0/feg/legacy/README.md

-security (HTTP2 & TLS) as well as support for multiple programming languages. The Remote Procedures below provide 
-simple, extensible, multi-language interfaces based on GRPC which allow developers to avoid dealing with the 
-complexities of 3GPP protocols. Implementing these RPC interfaces allows networks running on Magma to integrate 
+The federated gateway provides remote procedure call (GRPC) based interfaces to standard 3GPP components, such as


[markdownlint-fix] _{reported by reviewdog 🐶}

Suggested change

The federated gateway provides remote procedure call (GRPC) based interfaces to standard 3GPP components, such as

The federated gateway provides remote procedure call (GRPC) based interfaces to standard 3GPP components, such as

github-actions · 2024-02-29T20:55:18Z

docs/docusaurus/versioned_docs/version-1.0.0/feg/legacy/README.md

[markdownlint-fix] _{reported by reviewdog 🐶}

Suggested change

github-actions · 2024-02-29T20:55:18Z

docs/docusaurus/versioned_docs/version-1.0.0/feg/legacy/README.md

+ - `s6a_proxy` - translates calls from GRPC to S6a protocol between AGW and HSS
 - `session_proxy` - translates calls from GRPC to gx/gy protocol between AGW and PCRF/OCS
 - `csfb` - translates calls from GRPC interface to csfb protocol between AGW and VLR
 - `swx_proxy` - translates GRPC interface to SWx protocol between AGW and HSS
- - `gateway_health` - provides health updates to the orc8r to be used for 
- achieving highly available federated gateway clusters (see **[Magma Product Spec](https://github.com/facebookincubator/magma/blob/master/docs/Magma_Specs_V1.1.pdf)**
+ - `gateway_health` - provides health updates to the orc8r to be used for


[markdownlint-fix] _{reported by reviewdog 🐶}

Suggested change

- `s6a_proxy` - translates calls from GRPC to S6a protocol between AGW and HSS

- `session_proxy` - translates calls from GRPC to gx/gy protocol between AGW and PCRF/OCS

- `csfb` - translates calls from GRPC interface to csfb protocol between AGW and VLR

- `swx_proxy` - translates GRPC interface to SWx protocol between AGW and HSS

- `gateway_health` - provides health updates to the orc8r to be used for

achieving highly available federated gateway clusters (see **[Magma Product Spec](https://github.com/facebookincubator/magma/blob/master/docs/Magma_Specs_V1.1.pdf)**

- `gateway_health` - provides health updates to the orc8r to be used for

- `s6a_proxy` - translates calls from GRPC to S6a protocol between AGW and HSS

- `session_proxy` - translates calls from GRPC to gx/gy protocol between AGW and PCRF/OCS

- `csfb` - translates calls from GRPC interface to csfb protocol between AGW and VLR

- `swx_proxy` - translates GRPC interface to SWx protocol between AGW and HSS

- `gateway_health` - provides health updates to the orc8r to be used for

github-actions · 2024-02-29T20:55:18Z

docs/docusaurus/versioned_docs/version-1.0.0/feg/legacy/README.md

- - `gateway_health` - provides health updates to the orc8r to be used for 
- achieving highly available federated gateway clusters (see **[Magma Product Spec](https://github.com/facebookincubator/magma/blob/master/docs/Magma_Specs_V1.1.pdf)**
+ - `gateway_health` - provides health updates to the orc8r to be used for
+ achieving highly available federated gateway clusters (see **[Magma Product Spec](https://github.com/magma/magma/blob/v1.1.0/docs/Magma_Specs_V1.1.pdf)**
 for more details)
 - `radiusd` - fetches metrics from the running radius server and exports them


[markdownlint-fix] _{reported by reviewdog 🐶}

Suggested change

- `radiusd` - fetches metrics from the running radius server and exports them

- `radiusd` - fetches metrics from the running radius server and exports them

github-actions · 2024-02-29T20:55:18Z

docs/docusaurus/versioned_docs/version-1.0.0/symphony/download_requirements.md

@@ -14,7 +14,7 @@ If you are going to run or build the Symphony Agent you will need to install Doc
 There are some known limitations to running Docker on MacOS, the biggest being that you are unable to run ping over IPv6 from inside these Docker containers. But if you don't need your agent to do these things, this should be fine.




[markdownlint-fix] _{reported by reviewdog 🐶}

Suggested change

github-actions · 2024-02-29T20:55:22Z

docs/docusaurus/versioned_docs/version-1.6.X/contributing/contribute_conventions.md

@@ -233,15 +233,15 @@

 - For mandatory lint checks, we have a unit test that runs [Pylint](https://pypi.org/project/pylint/) on all gateway services
  - On CI, the check gets run as part of the `lte-test` job
- Additionally, we have a [Reviewdog](https://github.com/reviewdog/reviewdog) linter using [wemake-python-styleguide](https://wemake-python-stylegui.de/en/latest/) enabled to aid the code review process
+- Additionally, we have a [Reviewdog](https://github.com/reviewdog/reviewdog) linter using [wemake-python-styleguide](https://github.com/wemake-services/wemake-python-styleguide) enabled to aid the code review process
  - To run the linter locally, use the [precommit script](https://github.com/magma/magma/blob/master/lte/gateway/python/precommit.py)


[markdownlint-fix] _{reported by reviewdog 🐶}

Suggested change

- To run the linter locally, use the [precommit script](https://github.com/magma/magma/blob/master/lte/gateway/python/precommit.py)

- To run the linter locally, use the [precommit script](https://github.com/magma/magma/blob/master/lte/gateway/python/precommit.py)

github-actions · 2024-02-29T20:55:22Z

docs/docusaurus/versioned_docs/version-1.6.X/contributing/contribute_conventions.md

@@ -233,15 +233,15 @@

 - For mandatory lint checks, we have a unit test that runs [Pylint](https://pypi.org/project/pylint/) on all gateway services
  - On CI, the check gets run as part of the `lte-test` job
- Additionally, we have a [Reviewdog](https://github.com/reviewdog/reviewdog) linter using [wemake-python-styleguide](https://wemake-python-stylegui.de/en/latest/) enabled to aid the code review process
+- Additionally, we have a [Reviewdog](https://github.com/reviewdog/reviewdog) linter using [wemake-python-styleguide](https://github.com/wemake-services/wemake-python-styleguide) enabled to aid the code review process
  - To run the linter locally, use the [precommit script](https://github.com/magma/magma/blob/master/lte/gateway/python/precommit.py)

 **Formatters**

 - We recommend [autopep8](https://pypi.org/project/autopep8/) as it conforms to [pep8](https://www.python.org/dev/peps/pep-0008/)
  - The above-mentioned [precommit script](https://github.com/magma/magma/blob/master/lte/gateway/python/precommit.py) also has an option to format your changes with


[markdownlint-fix] _{reported by reviewdog 🐶}

Suggested change

- The above-mentioned [precommit script](https://github.com/magma/magma/blob/master/lte/gateway/python/precommit.py) also has an option to format your changes with

- The above-mentioned [precommit script](https://github.com/magma/magma/blob/master/lte/gateway/python/precommit.py) also has an option to format your changes with

github-actions · 2024-02-29T20:55:22Z

docs/docusaurus/versioned_docs/version-1.6.X/contributing/contribute_conventions.md

  - To run the linter locally, use the [precommit script](https://github.com/magma/magma/blob/master/lte/gateway/python/precommit.py)

 **Formatters**

 - We recommend [autopep8](https://pypi.org/project/autopep8/) as it conforms to [pep8](https://www.python.org/dev/peps/pep-0008/)
  - The above-mentioned [precommit script](https://github.com/magma/magma/blob/master/lte/gateway/python/precommit.py) also has an option to format your changes with
  [isort](https://pypi.org/project/isort/), [autopep8](https://pypi.org/project/autopep8/), and [add-trailing-comma](https://pypi.org/project/add-trailing-comma/)
- We do *not* recommend other formatters such as [black](https://black.readthedocs.io/en/stable/installation_and_usage.html), as it diverges from pep8 on basic things like line length, etc.
+- We do *not* recommend other formatters such as [black](https://ichard26-testblackdocs.readthedocs.io/en/refactor_docs/installation_and_usage.html), as it diverges from pep8 on basic things like line length, etc.




[markdownlint-fix] _{reported by reviewdog 🐶}

Suggested change

github-actions · 2024-02-29T20:55:22Z

docs/docusaurus/versioned_docs/version-1.6.X/lte/dev_notes.md

-  - `sudo ifup eth1`
-  - `sudo ip addr del 10.0.2.1/24 dev eth1`
+    - `sudo sed -i 's/address 10.0.2.1/address 192.168.60.142/g'`
+    ` /etc/network/interfaces.d/eth1`


[markdownlint-fix] _{reported by reviewdog 🐶}

Suggested change

` /etc/network/interfaces.d/eth1`

`/etc/network/interfaces.d/eth1`

github-actions · 2024-02-29T20:55:22Z

docs/docusaurus/versioned_docs/version-1.6.X/lte/dev_notes.md

 - Enable Pipelined `ryu_rest_service`
-  - `grep -qF 'ryu_rest_service' /etc/magma/pipelined.yml || sudo sed -i `
+    - `grep -qF 'ryu_rest_service' /etc/magma/pipelined.yml || sudo sed -i `


[markdownlint-fix] _{reported by reviewdog 🐶}

Suggested change

- `grep -qF 'ryu_rest_service' /etc/magma/pipelined.yml || sudo sed -i `

- `grep -qF 'ryu_rest_service' /etc/magma/pipelined.yml || sudo sed -i`

github-actions · 2024-02-29T20:55:53Z

lte/gateway/c/core/oai/include/spgw_types.hpp

-typedef magma::proto_map_s<uint32_t,
-                           struct s_plus_p_gw_eps_bearer_context_information_s*>
+// Data: S11BearerContext*
+// TODO (rsarwad): rename S11BearerContext to SpgwSessionContext and also


[cpplint] _{reported by reviewdog 🐶}
Missing username in TODO; it should look like "// TODO(my_username): Stuff." [readability/todo] [2]

github-actions · 2024-02-29T20:55:53Z

lte/gateway/c/core/oai/tasks/gtpv1-u/gtp_tunnel_openflow.cpp

@@ -103,7 +110,8 @@ static void add_portno_rec(char* port_name, uint32_t portno) {
      // all records.
      new_size = INIT_GTP_TABLE_SIZE;
    }
-    struct gtp_portno* new_arr = calloc(new_size, sizeof(struct gtp_portno));
+    struct gtp_portno* new_arr =
+        (gtp_portno*)calloc(new_size, sizeof(struct gtp_portno));


[cpplint] _{reported by reviewdog 🐶}
Using C-style cast. Use reinterpret_cast<gtp_portno*>(...) instead [readability/casting] [4]

github-actions · 2024-02-29T20:55:53Z

lte/gateway/c/core/oai/tasks/gtpv1-u/gtp_tunnel_openflow.cpp

@@ -267,7 +275,8 @@
  }
  OAILOG_INFO(LOG_GTPV1U, "Using GTP type: %s", ovs_gtp_type);

-  gtp_portno_rec.arr = calloc(INIT_GTP_TABLE_SIZE, sizeof(struct gtp_portno));
+  gtp_portno_rec.arr =
+      (gtp_portno*)calloc(INIT_GTP_TABLE_SIZE, sizeof(struct gtp_portno));


[cpplint] _{reported by reviewdog 🐶}
Using C-style cast. Use reinterpret_cast<gtp_portno*>(...) instead [readability/casting] [4]

github-actions · 2024-02-29T20:55:53Z

lte/gateway/c/core/oai/tasks/s1ap/s1ap_mme.cpp

-#include "lte/gateway/c/core/oai/include/mme_config.h"
+#include "lte/gateway/c/core/oai/include/mme_app_messages_types.hpp"
+#include "lte/gateway/c/core/oai/include/mme_config.hpp"
+#include "lte/gateway/c/core/oai/include/mme_init.hpp"


[cpplint] _{reported by reviewdog 🐶}
"lte/gateway/c/core/oai/include/mme_init.hpp" already included at lte/gateway/c/core/oai/tasks/s1ap/s1ap_mme.cpp:41 [build/include] [4]

github-actions · 2024-02-29T20:55:53Z

lte/gateway/c/core/oai/tasks/sgw/sgw_handlers.cpp

+      (proto_ip->pdn_type() == IPv6 || proto_ip->pdn_type() == IPv4_AND_v6)) {
+    inet_pton(AF_INET6, proto_ip->ipv6_addr().c_str(), ipv6);
+  }
+}


[cpplint] _{reported by reviewdog 🐶}
Closing brace should be aligned with beginning of struct in_addr [whitespace/indent] [3]

github-actions · 2024-02-29T20:55:53Z

lte/gateway/c/core/oai/tasks/sgw_s8/sgw_s8_handlers.cpp

+                                  eps_bearer_ctxt->s_gw_teid_S5_S8_up);
+      }
+
+      // TODO Need to add handling on failing to delete s1-u tunnel rules from


[cpplint] _{reported by reviewdog 🐶}
Missing username in TODO; it should look like "// TODO(my_username): Stuff." [readability/todo] [2]

github-actions

Remaining comments which cannot be posted as a review comment to avoid GitHub Rate Limit

pep8

github-actions · 2024-02-29T20:59:25Z

bazel/python_utils/conftest.py

@@ -0,0 +1,35 @@
+# Copyright 2022 The Magma Authors.


[pep8] _{reported by reviewdog 🐶}
D100 Missing docstring in public module

github-actions · 2024-02-29T20:59:25Z

bazel/python_utils/conftest.py

+
+
+@pytest.hookimpl()
+def pytest_sessionstart(session):


[pep8] _{reported by reviewdog 🐶}
D103 Missing docstring in public function

github-actions · 2024-02-29T20:59:25Z

bazel/python_utils/conftest.py

+@pytest.hookimpl()
+def pytest_sessionstart(session):
+    if os.geteuid() != 0:
+        raise Exception(


[pep8] _{reported by reviewdog 🐶}
WPS454 Found wrong raise exception type: Exception

github-actions · 2024-02-29T20:59:26Z

bazel/python_utils/conftest.py

+def pytest_sessionstart(session):
+    if os.geteuid() != 0:
+        raise Exception(
+            "\n\n" + \


[pep8] _{reported by reviewdog 🐶}
E502 the backslash is redundant between brackets

github-actions · 2024-02-29T20:59:26Z

bazel/python_utils/conftest.py

+    if os.geteuid() != 0:
+        raise Exception(
+            "\n\n" + \
+            "################################################################################\n" * 3 + \


[pep8] _{reported by reviewdog 🐶}
E502 the backslash is redundant between brackets

github-actions · 2024-02-29T20:59:29Z

lte/gateway/fabfile.py


+    pattern_template = "^  config.vm.define :{},.*$"


[pep8] _{reported by reviewdog 🐶}
P103 other string does contain unindexed parameters

github-actions · 2024-02-29T20:59:29Z

lte/gateway/fabfile.py


+    pattern_template = "^  config.vm.define :{},.*$"
+    open_port_template = '    {}.vm.network \"forwarded_port\", guest: 9443, host: 9443'


[pep8] _{reported by reviewdog 🐶}
P103 other string does contain unindexed parameters

github-actions · 2024-02-29T20:59:29Z

lte/gateway/fabfile.py

+    #    after line) works different on linux and macos (but would be more elegant)
+    # 2. don't use -i (inline replace), but copy .bak file - because syntax
+    #    differs between linux and macos
+    cmd_open_port_template = "sed '/{}/p; s/{}/{}/' Vagrantfile > v.bak && cp v.bak Vagrantfile && rm v.bak"


[pep8] _{reported by reviewdog 🐶}
P103 other string does contain unindexed parameters

github-actions · 2024-02-29T20:59:29Z

lte/gateway/fabfile.py

-        with settings(warn_only=True):
-            get(remote_path=TEST_SUMMARY_GLOB, local_path=dst_path)
+@task
+def get_test_summaries(c, sudo_tests=False, integration_tests=False):


[pep8] _{reported by reviewdog 🐶}
D103 Missing docstring in public function

github-actions · 2024-02-29T20:59:29Z

lte/gateway/fabfile.py

+@task
+def get_test_summaries(c, sudo_tests=False, integration_tests=False):
+    results_folder = "test_results"
+    results_dir = "/var/tmp/"


[pep8] _{reported by reviewdog 🐶}
S108 Probable insecure usage of temp file/directory.

github-actions · 2024-03-08T21:54:14Z

❌ The Semantic PR check ended with status failure. See instructions on formatting your commit and pull request titles.

github-actions · 2024-03-08T21:54:40Z

DP Lint & Test

0 tests 0 ✔️ 0s ⏱️
0 suites 0 💤
0 files 0 ❌

Results for commit 06559a0.

♻️ This comment has been updated with latest results.

…ment security limitations. Fixes magma/security#179 Fixes magma/security#182 Signed-off-by: Lucas Gonze <lucas@gonze.com>

lucasgonze requested review from a team as code owners February 29, 2024 20:54

lucasgonze requested review from andreilee, electronjoe and ShubhamTatvamasi February 29, 2024 20:54

github-actions bot added the component: ci All updates on CI (Jenkins/CircleCi/Github Action) label Feb 29, 2024

github-actions bot reviewed Feb 29, 2024

View reviewed changes

lucasgonze force-pushed the security-179 branch from 205b514 to 05be717 Compare March 8, 2024 21:53

pull-request-size bot added the size/XS Denotes a PR that changes 0-9 lines. label Mar 8, 2024

Add acknowledgement for submitter, Nathaniel Bennett, to README. Docu…

06559a0

…ment security limitations. Fixes magma/security#179 Fixes magma/security#182 Signed-off-by: Lucas Gonze <lucas@gonze.com>

lucasgonze force-pushed the security-179 branch from 05be717 to 06559a0 Compare March 8, 2024 21:56


		# Deploy Orchestrator using Ansible (Beta)

		This how-to guide can be used to deploy Magma's Orchestrator on any cloud environment.

	The federated gateway provides remote procedure call (GRPC) based interfaces to standard 3GPP components, such as

	The federated gateway provides remote procedure call (GRPC) based interfaces to standard 3GPP components, such as

	- `radiusd` - fetches metrics from the running radius server and exports them
	- `radiusd` - fetches metrics from the running radius server and exports them

		@@ -14,7 +14,7 @@ If you are going to run or build the Symphony Agent you will need to install Doc
		There are some known limitations to running Docker on MacOS, the biggest being that you are unable to run ping over IPv6 from inside these Docker containers. But if you don't need your agent to do these things, this should be fine.

	- To run the linter locally, use the [precommit script](https://github.com/magma/magma/blob/master/lte/gateway/python/precommit.py)
	- To run the linter locally, use the [precommit script](https://github.com/magma/magma/blob/master/lte/gateway/python/precommit.py)

	- The above-mentioned [precommit script](https://github.com/magma/magma/blob/master/lte/gateway/python/precommit.py) also has an option to format your changes with
	- The above-mentioned [precommit script](https://github.com/magma/magma/blob/master/lte/gateway/python/precommit.py) also has an option to format your changes with

	` /etc/network/interfaces.d/eth1`
	`/etc/network/interfaces.d/eth1`

	- `grep -qF 'ryu_rest_service' /etc/magma/pipelined.yml \|\| sudo sed -i `
	- `grep -qF 'ryu_rest_service' /etc/magma/pipelined.yml \|\| sudo sed -i`


		pattern_template = "^ config.vm.define :{},.*$"
		open_port_template = ' {}.vm.network \"forwarded_port\", guest: 9443, host: 9443'

docs: security acknowledgement #15387

Are you sure you want to change the base?

docs: security acknowledgement #15387

Conversation

lucasgonze commented Feb 29, 2024

Summary

Test Plan

Additional Information

Security Considerations

github-actions bot commented Feb 29, 2024

Howto

More info

github-actions bot Feb 29, 2024

Choose a reason for hiding this comment

github-actions bot Feb 29, 2024

Choose a reason for hiding this comment

github-actions bot Feb 29, 2024

Choose a reason for hiding this comment

github-actions bot Feb 29, 2024

Choose a reason for hiding this comment

github-actions bot Feb 29, 2024

Choose a reason for hiding this comment

github-actions bot Feb 29, 2024

Choose a reason for hiding this comment

github-actions bot left a comment

Choose a reason for hiding this comment

github-actions bot Feb 29, 2024

Choose a reason for hiding this comment

github-actions bot Feb 29, 2024

Choose a reason for hiding this comment

github-actions bot Feb 29, 2024

Choose a reason for hiding this comment

github-actions bot Feb 29, 2024

Choose a reason for hiding this comment

github-actions bot Feb 29, 2024

Choose a reason for hiding this comment

github-actions bot Feb 29, 2024

Choose a reason for hiding this comment

github-actions bot Feb 29, 2024

Choose a reason for hiding this comment

github-actions bot Feb 29, 2024

Choose a reason for hiding this comment

github-actions bot Feb 29, 2024

Choose a reason for hiding this comment

github-actions bot Feb 29, 2024

Choose a reason for hiding this comment

github-actions bot Feb 29, 2024

Choose a reason for hiding this comment

github-actions bot Feb 29, 2024

Choose a reason for hiding this comment

github-actions bot Feb 29, 2024

Choose a reason for hiding this comment

github-actions bot Feb 29, 2024

Choose a reason for hiding this comment

github-actions bot Feb 29, 2024

Choose a reason for hiding this comment

github-actions bot Feb 29, 2024

Choose a reason for hiding this comment

github-actions bot left a comment

Choose a reason for hiding this comment

github-actions bot Feb 29, 2024

Choose a reason for hiding this comment

github-actions bot Feb 29, 2024

Choose a reason for hiding this comment

github-actions bot Feb 29, 2024

Choose a reason for hiding this comment

github-actions bot Feb 29, 2024

Choose a reason for hiding this comment

github-actions bot Feb 29, 2024

Choose a reason for hiding this comment

github-actions bot Feb 29, 2024

Choose a reason for hiding this comment

github-actions bot Feb 29, 2024

Choose a reason for hiding this comment

github-actions bot Feb 29, 2024

Choose a reason for hiding this comment

github-actions bot Feb 29, 2024

Choose a reason for hiding this comment

github-actions bot Feb 29, 2024

Choose a reason for hiding this comment

github-actions bot commented Mar 8, 2024 •

edited