Skip to content
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.

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

Technical Writer: made changes to enhance clarity - section in 0x04 ("guide") moved to 0x03 #2548

Merged
merged 6 commits into from
Feb 20, 2024

Conversation

thornshadow99
Copy link
Contributor

@thornshadow99 thornshadow99 commented Feb 8, 2024

Thank you for submitting a Pull Request to the OWASP MASTG. Please make sure that:

  • Your contribution is written in the 2nd person (e.g. you)
  • Your contribution is written in an active present form for as much as possible.
  • You have made sure that the reference section is up to date (e.g. please add sources you have used, make sure that the references to MITRE/MASVS/etc. are up to date)
  • Your contribution has proper formatted markdown and/or code
  • Any references to website have been formatted as [TEXT](URL “NAME”)
  • You verified/tested the effectiveness of your contribution (e.g.: is the code really an effective remediation? Please verify it works!)

If your PR is related to an issue. Please end your PR test with the following line:
This PR closes #< insert number here >.

@cpholguera
Copy link
Collaborator

Hi @thornshadow99, you may ignore the spell checker for now, however you have a couple of markdown lint errors which you'd need to fix. Here you can see the file, line number, character position and the error:

Document/0x03-Overview.md:5:54 MD009/no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1]
Document/0x04a-Mobile-App-Taxonomy.md:7:43 MD009/no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1]
Document/0x04a-Mobile-App-Taxonomy.md:58 MD012/no-multiple-blanks Multiple consecutive blank lines [Expected: 1; Actual: 2]
Document/0x04a-Mobile-App-Taxonomy.md:59 MD012/no-multiple-blanks Multiple consecutive blank lines [Expected: 1; Actual: 3]


The protection of sensitive data, such as user credentials and private information, is crucial to mobile security. If an app uses operating system APIs such as local storage or inter-process communication (IPC) improperly, the app might expose sensitive data to other apps running on the same device. It may also unintentionally leak data to cloud storage, backups, or the keyboard cache. Additionally, mobile devices can be lost or stolen more easily compared to other types of devices, so it's more likely an individual can gain physical access to the device, making it easier to retrieve the data.
### <A id="datastorage"></a> MASVS-STORAGE: Data Storage and Privacy
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why these <a> elements? Markdown generates HTML IDs automatically

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I see now. You want to include an index. You can use the sections titles. Just put them in all lowercase and use dashes. For example:

MASVS-STORAGE: Data Storage and Privacy

Turns into: masvs-storage-data-storage-and-privacy

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I got it now. Beg pardon.

@thornshadow99
Copy link
Contributor Author

thornshadow99 commented Feb 9, 2024 via email

@cpholguera
Copy link
Collaborator

Hi @thornshadow99, that's correct, you go to your branch and fix those issues and then push. There's no need to open a new Pull Requests. Your push updates the current PR.

@cpholguera
Copy link
Collaborator

These are the last 2 errors to fix:

Error: Document/0x03-Overview.md:5:54 MD009/no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1]

Error: Document/0x04a-Mobile-App-Taxonomy.md:55:367 MD047/single-trailing-newline Files should end with a single newline character


The [OWASP Mobile Application Security _Verification Standard_ (MASVS)](https://mas.owasp.org/MASVS/) defines a mobile app security model and lists generic security requirements for mobile apps. It can be used by architects, developers, testers, security professionals, and consumers to define and understand the qualities of a secure mobile app. The [OWASP Mobile Application Security _Testing Guide_ (MASTG)](https://mas.owasp.org/MASTG/) maps to the same basic set of security requirements offered by the MASVS and depending on the context they can be used individually or combined to achieve different objectives.
## How to Use the Mobile Application Security Project
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fix for:

Error: Document/0x03-Overview.md:5:54 MD009/no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1]

Suggested change
## How to Use the Mobile Application Security Project
## How to Use the Mobile Application Security Project

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Got it.

Document/0x04a-Mobile-App-Taxonomy.md Outdated Show resolved Hide resolved
Document/0x04a-Mobile-App-Taxonomy.md Outdated Show resolved Hide resolved

The protection of sensitive data, such as user credentials and private information, is crucial to mobile security. If an app uses operating system APIs such as local storage or inter-process communication (IPC) improperly, the app might expose sensitive data to other apps running on the same device. It may also unintentionally leak data to cloud storage, backups, or the keyboard cache. Additionally, mobile devices can be lost or stolen more easily compared to other types of devices, so it's more likely an individual can gain physical access to the device, making it easier to retrieve the data.
### <A id="datastorage"></a> MASVS-STORAGE: Data Storage and Privacy
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
### <A id="datastorage"></a> MASVS-STORAGE: Data Storage and Privacy
### MASVS-STORAGE: Data Storage and Privacy

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Right.


### Data Storage and Privacy (MASVS-STORAGE)
[Data Storage and Privacy](#datastorage)
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
[Data Storage and Privacy](#datastorage)
[Data Storage and Privacy](#masvs-storage-data-storage-and-privacy)

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

and so on

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I understand now. Just used the wrong reference online. Beg pardon.

@thornshadow99
Copy link
Contributor Author

thornshadow99 commented Feb 10, 2024 via email

0x04: Index properly implemented and alt text given to IMG SRC in line 9
Document/0x04a-Mobile-App-Taxonomy.md Outdated Show resolved Hide resolved
Document/0x03-Overview.md Outdated Show resolved Hide resolved
Copy link
Collaborator

@cpholguera cpholguera left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks a lot @thornshadow99!

@cpholguera cpholguera merged commit 68cc51a into OWASP:master Feb 20, 2024
4 of 5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants