summaryrefslogtreecommitdiff
path: root/src/mongo/util/icu.h
blob: 2f10aecf4e75925fdb5a220e2266a3db34e87457 (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
/**
 *    Copyright (C) 2018-present MongoDB, Inc.
 *
 *    This program is free software: you can redistribute it and/or modify
 *    it under the terms of the Server Side Public License, version 1,
 *    as published by MongoDB, Inc.
 *
 *    This program is distributed in the hope that it will be useful,
 *    but WITHOUT ANY WARRANTY; without even the implied warranty of
 *    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *    Server Side Public License for more details.
 *
 *    You should have received a copy of the Server Side Public License
 *    along with this program. If not, see
 *    <http://www.mongodb.com/licensing/server-side-public-license>.
 *
 *    As a special exception, the copyright holders give permission to link the
 *    code of portions of this program with the OpenSSL library under certain
 *    conditions as described in each individual source file and distribute
 *    linked combinations including the program with the OpenSSL library. You
 *    must comply with the Server Side Public License in all respects for
 *    all of the code used other than as permitted herein. If you modify file(s)
 *    with this exception, you may extend this exception to your version of the
 *    file(s), but you are not obligated to do so. If you do not wish to do so,
 *    delete this exception statement from your version. If you delete this
 *    exception statement from all source files in the program, then also delete
 *    it in the license file.
 */

#pragma once

#include <string>

#include "mongo/base/status_with.h"
#include "mongo/base/string_data.h"

namespace mongo {

/**
 * Unicode string prepare options.
 * By default, unassigned codepoints in the input string will result in an error.
 * Using the AllowUnassigned option will pass them through without change,
 * which may not turn out to be appropriate in later Unicode standards.
 */
enum UStringPrepOptions {
    kUStringPrepDefault = 0,
    kUStringPrepAllowUnassigned = 1,
};

/**
 * Attempt to apply RFC4013 saslPrep to the target string.
 * Normalizes unicode sequences for SCRAM authentication.
 */
StatusWith<std::string> icuSaslPrep(StringData str, UStringPrepOptions = kUStringPrepDefault);

/**
 * Attempt to apply RFC4518 string prep to the target string, this normalizes an X509 DN
 * so it can be compared against other X509 DNs
 */
StatusWith<std::string> icuX509DNPrep(StringData str);

}  // namespace mongo