Skip to content
Snippets Groups Projects

feat(Obfuscation): add obfuscation guidelines

Merged Dan MH requested to merge email-obfuscation-guidelines-danmh into main

What does this MR do?

Email obfuscation came up in gitlab-org/gitlab!108901 (comment 1239082646) and it looks like it is a new pattern.

This MR documents the pattern decided so we can use it consistently across the product.

Want to use email obfuscation in code?

You can obfuscate emails from any place in the backend application with Gitlab::Utils::Email.obfuscated_email("see@me.com.uk", deform: true) (maybe , deform: true can be omitted when we decide we only want to have one version of email obfuscation).

Want to help document other obfuscation patterns?

Contribute to the follow up issue Improve obfuscation guidelines with further exa... (#1520)

Does this MR meet the acceptance criteria?

Links

Edited by Dan MH

Merge request reports

Loading
Loading

Activity

Filter activity
  • Approvals
  • Assignees & reviewers
  • Comments (from bots)
  • Comments (from users)
  • Commits & branches
  • Edits
  • Labels
  • Lock status
  • Mentions
  • Merge request status
  • Tracking
  • Marc Saleiko
  • Marc Saleiko
    • Resolved by Marc Saleiko

      I don't know whether we display method calls in the Pajamas documentation. If that's the case, we could add that you can obfuscate emails from any place in the backend application with Gitlab::Utils::Email.obfuscated_email("see@me.com.uk", deform: true) (maybe , deform: true can be omitted when we decide we only want to have one version of email obfuscation).

  • Dan MH changed the description

    changed the description

  • Dan MH added 1 commit

    added 1 commit

    Compare with previous version

  • Dan MH requested review from @msaleiko and @cmaxim

    requested review from @msaleiko and @cmaxim

  • Loading
  • Loading
  • Loading
  • Loading
  • Loading
  • Loading
  • Loading
  • Loading
  • Loading
  • Loading
  • Please register or sign in to reply
    Loading