Skip to content

chore(*): remove sample access key from SDK documentation #102

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

Merged
merged 8 commits into from
Feb 27, 2024
Merged

chore(*): remove sample access key from SDK documentation #102

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
84cae53
chore(*): remove sample access key from SDK documentation
outsinre Jan 31, 2024
90911c4
chore(*): revert me before merge
outsinre Jan 31, 2024
09a64b8
fix(*): discard filename template
outsinre Jan 31, 2024
dea605d
fix(*): recreate temp file
outsinre Jan 31, 2024
6af6ad9
Revert "chore(*): revert me before merge"
outsinre Jan 31, 2024
df4cb19
Add a comment to explain the purpose.
outsinre Feb 23, 2024
6b99c6f
docs(*): add a changelog entry
outsinre Feb 27, 2024
04d0db2
Update README.md
outsinre Feb 27, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -182,6 +182,9 @@ Release process:
[94](https://github.com/Kong/lua-resty-aws/pull/94)
- fix: fix the bug of missing boolean type with a value of false in the generated request body
[100](https://github.com/Kong/lua-resty-aws/pull/100)
- security: remove the documentation entry that contains a sample access key from AWS SDK. This
avoids false postive vulnerability report.
[102](https://github.com/Kong/lua-resty-aws/pull/102)

### 1.3.6 (25-Dec-2023)

Expand Down
4 changes: 4 additions & 0 deletions update_api_files.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ SDK_VERSION_TAG=v2.751.0
# ----------- nothing to customize below -----------
TARGET=./src/resty/aws/raw-api
SOURCE=./delete-me
TFILE=$(mktemp)
set -e
pushd "$(dirname "$(realpath "$0")")" > /dev/null

Expand Down Expand Up @@ -74,6 +75,9 @@ echo "]===]))" >> "$FILENAME"
# Copy the individual API files
for f in "${file_list[@]}"; do
source_file=$SOURCE/apis/$f.normal.json
# remove example keys from documentation to prevent security reports from being triggered
jq 'walk( if (type == "object") and has("documentation") and (.documentation|contains("wJalrXUtnFEMI")) then del(.documentation) else . end )' "$source_file" >| "$TFILE"
mv -f "$TFILE" "$source_file"; touch "$TFILE"
# replace . with - since . can't be in a Lua module name
target_file=$TARGET/${f//./-}.lua
echo "adding: $target_file"
Expand Down