1 2 /** 3 * Copyright (C) 2018-present MongoDB, Inc. 4 * 5 * This program is free software: you can redistribute it and/or modify 6 * it under the terms of the Server Side Public License, version 1, 7 * as published by MongoDB, Inc. 8 * 9 * This program is distributed in the hope that it will be useful, 10 * but WITHOUT ANY WARRANTY; without even the implied warranty of 11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 12 * Server Side Public License for more details. 13 * 14 * You should have received a copy of the Server Side Public License 15 * along with this program. If not, see 16 * <http://www.mongodb.com/licensing/server-side-public-license>. 17 * 18 * As a special exception, the copyright holders give permission to link the 19 * code of portions of this program with the OpenSSL library under certain 20 * conditions as described in each individual source file and distribute 21 * linked combinations including the program with the OpenSSL library. You 22 * must comply with the Server Side Public License in all respects for 23 * all of the code used other than as permitted herein. If you modify file(s) 24 * with this exception, you may extend this exception to your version of the 25 * file(s), but you are not obligated to do so. If you do not wish to do so, 26 * delete this exception statement from your version. If you delete this 27 * exception statement from all source files in the program, then also delete 28 * it in the license file. 29 */ 30 31 #pragma once 32 33 namespace mongo { 34 class BSONObj; 35 36 /** 37 * @return true if internal authentication parameters has been set up. Note this does not 38 * imply that auth is enabled. For instance, with the --transitionToAuth flag this will 39 * be set and auth will be disabled. 40 */ 41 bool isInternalAuthSet(); 42 43 /** 44 * This method initializes the authParams object with authentication 45 * credentials to be used by authenticateInternalUser. 46 */ 47 void setInternalUserAuthParams(const BSONObj& authParamsIn); 48 49 /** 50 * Returns a copy of the authParams object to be used by authenticateInternalUser 51 * 52 * The format of the return object is { authparams, fallbackParams:params} 53 * 54 * If SCRAM-SHA-1 is the internal auth mechanism the fallbackParams sub document is 55 * for MONGODB-CR auth is included. For MONGODB-XC509 no fallbackParams document is 56 * returned. 57 **/ 58 BSONObj getInternalUserAuthParams(); 59 } // namespace mongo 60