aboutsummaryrefslogtreecommitdiffstats
path: root/datarouter-node/src/main/java/org/onap/dmaap/datarouter/node/PathUtil.java
blob: d67c9094c8274e9df74ba01f26f297e3ba636907 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
/*-
 * ============LICENSE_START=======================================================
 *  Copyright (C) 2019 Nordix Foundation.
 * ================================================================================
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 * SPDX-License-Identifier: Apache-2.0
 * ============LICENSE_END=========================================================
 */

package org.onap.dmaap.datarouter.node;

/**
 * FORTIFY SCAN FIXES.
 * <p>This Utility is used for Fortify fixes. It Validates the path url formed from
 * the string passed in the request parameters.</p>
 */
class PathUtil {

    private PathUtil() {
        throw new IllegalStateException("Utility Class");
    }

    /**
     * This method takes String as the parameter and return the filtered path string.
     *
     * @param string String to clean
     * @return A cleaned String
     */
    static String cleanString(String string) {
        if (string == null) {
            return null;
        }
        StringBuilder cleanString = new StringBuilder();
        for (int i = 0; i < string.length(); ++i) {
            cleanString.append(cleanChar(string.charAt(i)));
        }
        return cleanString.toString();
    }

    /**
     * This method filters the valid special characters in path string.
     *
     * @param character The char to be cleaned
     * @return The cleaned char
     */
    private static char cleanChar(char character) {
        // 0 - 9
        for (int i = 48; i < 58; ++i) {
            if (character == i) {
                return (char) i;
            }
        }
        // 'A' - 'Z'
        for (int i = 65; i < 91; ++i) {
            if (character == i) {
                return (char) i;
            }
        }
        // 'a' - 'z'
        for (int i = 97; i < 123; ++i) {
            if (character == i) {
                return (char) i;
            }
        }
        return getValidCharacter(character);
    }

    private static char getValidCharacter(char character) {
        // other valid characters
        switch (character) {
            case '/':
                return '/';
            case '.':
                return '.';
            case '-':
                return '-';
            case ':':
                return ':';
            case '?':
                return '?';
            case '&':
                return '&';
            case '=':
                return '=';
            case '#':
                return '#';
            case '_':
                return '_';
            case ' ':
                return ' ';
            default:
                return '%';
        }
    }
}