commons-issues mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "ASF GitHub Bot (JIRA)" <j...@apache.org>
Subject [jira] [Commented] (LANG-1400) StringUtils: Add method for masking strings
Date Wed, 26 Sep 2018 06:50:00 GMT

    [ https://issues.apache.org/jira/browse/LANG-1400?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16628314#comment-16628314
] 

ASF GitHub Bot commented on LANG-1400:
--------------------------------------

Github user aaabramov commented on the issue:

    https://github.com/apache/commons-lang/pull/335
  
    > Sounds reasonable in the same time it will not always obviously which minMasked to
use.
    > For example already mentioned credit card numbers in fact can have varying length
as I remember up to 24 digits.
    > As I understood I created this function for specific case which you had. Can you
provide some examples from real life when minMasked was needed?
    
    FYI, card numbers can vary from 13 to 19 digits. PCI DSS allows to log PANs mask in such
way:
    Here is proper maskifying Scala code:
    ```
        val START_SYMBOLS = 6
        val END_SYMBOLS = 4
        val TOTAL_SYMBOLS: Int = START_SYMBOLS + END_SYMBOLS
    
        private def stars(count: Int): String = "*" * count
    
        def maskify(number): String =
          if (number.length <= 6) {
            number
          } else {
            val maskLength = (number.length - TOTAL_SYMBOLS).max(0)
            val numberFromEnd = maskLength + START_SYMBOLS
            number.substring(0, 6) + stars(maskLength) + number.substring(numberFromEnd)
          }
    ```
    
    As a result:
    ```
    4242424242424242     ~> 424242******4242
    424242424242424242 ~>424242********4242
    ```


> StringUtils: Add method for masking strings
> -------------------------------------------
>
>                 Key: LANG-1400
>                 URL: https://issues.apache.org/jira/browse/LANG-1400
>             Project: Commons Lang
>          Issue Type: Improvement
>          Components: lang.*
>            Reporter: Sergey Ponomarev
>            Priority: Minor
>
> It would be great to have a function which allows to mask the original str by replacing
it's
> characters with the specified character-mask. For eaxmple to mask credit card:
> {code}
> mask("3566002020360505", 4, 4, '*') = "3566********0505"
> {code}
> Thus the number was hidden by asterisks while first and last four digits are unmasked
and seen.
> Common use case is to hide sensitive information from logs, by using it in toString()
of classes or in inputs to log calls.
> I think this is "must have" functionality for Commons Lang library because from my experience
in almost all bit projects what I saw was their home grown masking function.
> I think this is very important also because this is required for masking credit card
numbers by PCI compliance. Also new GDPR rules requires to hide personal info as much as possible
so masking of First and Last names now is required by laws.
> To make the world safer place the utility for masking should be already existing in platform
to avoid situations when developer think  "this is better to mask but I don't have enough
time now so let's do this latter" until leak happens.
> IMHO this should be implemented even in `String` class itself.
> From my experience what I saw was usually few masking usages and styles:
> 1. masking of passwords and names: only first and last symbols are shown, mask char is
`*`
> 2. masking of credit cards: only first and last 4 or 6 symbols are shown, mask char is
`*`.
> 3. credit card number shortest masking of last symbols i.e. `mask("4242424242424242")
== " *4242"` but it's not so often used, I just wanted to mention.
> 4. not masking but showing a length just so see that value was passed. This can be easily
achieved by usual `String.legth()` method.
> There is already some pull request [https://github.com/apache/commons-lang/pull/332]
but I decided to create the ticket because we also need to support masking for ToStringBuilder
and I would like to propose [PR with my own implementation of mask() function|https://github.com/apache/commons-lang/pull/335].
> If you accept my PR then I'll send another one with a new annotation @ToStringMasked
in accordance to [@ToStringExclude|https://commons.apache.org/proper/commons-lang/apidocs/org/apache/commons/lang3/builder/ToStringExclude.html]
which will mark that fields should be masked. Possible usage I see like:
> {code}
> @ToStringMasked(unmaskedStart = 4, unmaskedEnd = 4) 
> String creditCardNumber;
> @ToStringMasked(unmaskedStart = 1, unmaskedEnd = 1) 
> String password;
> {code}
>  



--
This message was sent by Atlassian JIRA
(v7.6.3#76005)

Mime
View raw message