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
107
|
# Copyright (C) 2014-2017 MongoDB, Inc.
#
# 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.
require 'mongo/auth/cr'
require 'mongo/auth/ldap'
require 'mongo/auth/scram'
require 'mongo/auth/user'
require 'mongo/auth/x509'
require 'mongo/auth/roles'
module Mongo
# This namespace contains all authentication related behaviour.
#
# @since 2.0.0
module Auth
extend self
# The external database name.
#
# @since 2.0.0
EXTERNAL = '$external'.freeze
# Constant for the nonce command.
#
# @since 2.0.0
GET_NONCE = { getnonce: 1 }.freeze
# Constant for the nonce field.
#
# @since 2.0.0
NONCE = 'nonce'.freeze
# Map the symbols parsed from the URI connection string to strategies.
#
# @since 2.0.0
SOURCES = {
mongodb_cr: CR,
mongodb_x509: X509,
plain: LDAP,
scram: SCRAM
}
# Get the authorization strategy for the provided auth mechanism.
#
# @example Get the strategy.
# Auth.get(user)
#
# @param [ Auth::User ] user The user object.
#
# @return [ CR, X509, LDAP, Kerberos ] The auth strategy.
#
# @since 2.0.0
def get(user)
mechanism = user.mechanism
raise InvalidMechanism.new(mechanism) if !SOURCES.has_key?(mechanism)
SOURCES[mechanism].new(user)
end
# Raised when trying to get an invalid authorization mechanism.
#
# @since 2.0.0
class InvalidMechanism < RuntimeError
# Instantiate the new error.
#
# @example Instantiate the error.
# Mongo::Auth::InvalidMechanism.new(:test)
#
# @param [ Symbol ] mechanism The provided mechanism.
#
# @since 2.0.0
def initialize(mechanism)
super("#{mechanism.inspect} is invalid, please use mongodb_cr, mongodb_x509, gssapi or plain.")
end
end
# Raised when a user is not authorized on a database.
#
# @since 2.0.0
class Unauthorized < RuntimeError
# Instantiate the new error.
#
# @example Instantiate the error.
# Mongo::Auth::Unauthorized.new(user)
#
# @param [ Mongo::Auth::User ] user The unauthorized user.
#
# @since 2.0.0
def initialize(user)
super("User #{user.name} is not authorized to access #{user.database}.")
end
end
end
end
|
