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
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
|
% 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.
-module(couch_users_db).
-export([before_doc_update/2, after_doc_read/2, strip_non_public_fields/1]).
-include_lib("couch/include/couch_db.hrl").
-define(NAME, <<"name">>).
-define(PASSWORD, <<"password">>).
-define(DERIVED_KEY, <<"derived_key">>).
-define(PASSWORD_SCHEME, <<"password_scheme">>).
-define(SIMPLE, <<"simple">>).
-define(PASSWORD_SHA, <<"password_sha">>).
-define(PBKDF2, <<"pbkdf2">>).
-define(ITERATIONS, <<"iterations">>).
-define(SALT, <<"salt">>).
-define(replace(L, K, V), lists:keystore(K, 1, L, {K, V})).
% If the request's userCtx identifies an admin
% -> save_doc (see below)
%
% If the request's userCtx.name is null:
% -> save_doc
% // this is an anonymous user registering a new document
% // in case a user doc with the same id already exists, the anonymous
% // user will get a regular doc update conflict.
% If the request's userCtx.name doesn't match the doc's name
% -> 404 // Not Found
% Else
% -> save_doc
before_doc_update(Doc, Db) ->
#user_ctx{name=Name} = couch_db:get_user_ctx(Db),
DocName = get_doc_name(Doc),
case (catch couch_db:check_is_admin(Db)) of
ok ->
save_doc(Doc);
_ when Name =:= DocName orelse Name =:= null ->
save_doc(Doc);
_ ->
throw(not_found)
end.
% If newDoc.password == null || newDoc.password == undefined:
% ->
% noop
% Else -> // calculate password hash server side
% newDoc.password_sha = hash_pw(newDoc.password + salt)
% newDoc.salt = salt
% newDoc.password = null
save_doc(#doc{body={Body}} = Doc) ->
%% Support both schemes to smooth migration from legacy scheme
Scheme = config:get("couch_httpd_auth", "password_scheme", "pbkdf2"),
case {couch_util:get_value(?PASSWORD, Body), Scheme} of
{null, _} -> % server admins don't have a user-db password entry
Doc;
{undefined, _} ->
Doc;
{ClearPassword, "simple"} -> % deprecated
Salt = couch_uuids:random(),
PasswordSha = couch_passwords:simple(ClearPassword, Salt),
Body0 = ?replace(Body, ?PASSWORD_SCHEME, ?SIMPLE),
Body1 = ?replace(Body0, ?SALT, Salt),
Body2 = ?replace(Body1, ?PASSWORD_SHA, PasswordSha),
Body3 = proplists:delete(?PASSWORD, Body2),
Doc#doc{body={Body3}};
{ClearPassword, "pbkdf2"} ->
Iterations = list_to_integer(config:get("couch_httpd_auth", "iterations", "1000")),
Salt = couch_uuids:random(),
DerivedKey = couch_passwords:pbkdf2(ClearPassword, Salt, Iterations),
Body0 = ?replace(Body, ?PASSWORD_SCHEME, ?PBKDF2),
Body1 = ?replace(Body0, ?ITERATIONS, Iterations),
Body2 = ?replace(Body1, ?DERIVED_KEY, DerivedKey),
Body3 = ?replace(Body2, ?SALT, Salt),
Body4 = proplists:delete(?PASSWORD, Body3),
Doc#doc{body={Body4}};
{_ClearPassword, Scheme} ->
couch_log:error("[couch_httpd_auth] password_scheme value of '~p' is invalid.", [Scheme]),
throw({forbidden, "Server cannot hash passwords at this time."})
end.
% If the doc is a design doc
% If the request's userCtx identifies an admin
% -> return doc
% Else
% -> 403 // Forbidden
% If the request's userCtx identifies an admin
% -> return doc
% If the request's userCtx.name doesn't match the doc's name
% -> 404 // Not Found
% Else
% -> return doc
after_doc_read(#doc{id = <<?DESIGN_DOC_PREFIX, _/binary>>} = Doc, Db) ->
case (catch couch_db:check_is_admin(Db)) of
ok ->
Doc;
_ ->
throw({forbidden,
<<"Only administrators can view design docs in the users database.">>})
end;
after_doc_read(Doc, Db) ->
#user_ctx{name=Name} = couch_db:get_user_ctx(Db),
DocName = get_doc_name(Doc),
case (catch couch_db:check_is_admin(Db)) of
ok ->
Doc;
_ when Name =:= DocName ->
Doc;
_ ->
Doc1 = strip_non_public_fields(Doc),
case Doc1 of
#doc{body={[]}} ->
throw(not_found);
_ ->
Doc1
end
end.
get_doc_name(#doc{id= <<"org.couchdb.user:", Name/binary>>}) ->
Name;
get_doc_name(_) ->
undefined.
strip_non_public_fields(#doc{body={Props}}=Doc) ->
Public = re:split(config:get("couch_httpd_auth", "public_fields", ""),
"\\s*,\\s*", [{return, binary}]),
Doc#doc{body={[{K, V} || {K, V} <- Props, lists:member(K, Public)]}}.
|
