-
Notifications
You must be signed in to change notification settings - Fork 7
/
roles.go
143 lines (123 loc) · 4.69 KB
/
roles.go
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
138
139
140
141
142
143
// Copyright (c) 2020, Cloudflare. All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are met:
// 1. Redistributions of source code must retain the above copyright notice,
// this list of conditions and the following disclaimer.
// 2. Redistributions in binary form must reproduce the above copyright notice,
// this list of conditions and the following disclaimer in the documentation
// and/or other materials provided with the distribution.
// 3. Neither the name of the copyright holder nor the names of its contributors
// may be used to endorse or promote products derived from this software without
// specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
// ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
// LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
// CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
// SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
// INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
// CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
// ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
// POSSIBILITY OF SUCH DAMAGE.
package opaque
import (
"crypto"
"github.com/cloudflare/circl/oprf"
"github.com/cloudflare/opaque-core/common"
)
// Server holds state for an instance of the server role in OPAQUE.
type Server struct {
Config *ServerConfig
UserRecord *UserRecord
}
// ServerConfig holds long term state for the server.
type ServerConfig struct {
ServerID string
Signer crypto.Signer
RecordTable UserRecordTable
Suite oprf.SuiteID
CredentialEncodingPolicy *CredentialEncodingPolicy
}
// CredentialEncodingPolicy indicates which user credentials are stored,
// and whether they are held encrypted or in cleartext.
type CredentialEncodingPolicy struct {
SecretTypes []CredentialType
CleartextTypes []CredentialType
}
// Client holds state for the client role in OPAQUE.
type Client struct {
UserID []byte
ServerID []byte
oprf1 *oprf.ClientRequest
oprfState *oprf.Client
signer crypto.Signer
suite oprf.SuiteID
}
// NewServer returns a new OPAQUE server with the RECOMMENDED credential
// encoding policy.
func NewServer(cfg *ServerConfig) (*Server, error) {
if cfg.CredentialEncodingPolicy == nil {
cfg.CredentialEncodingPolicy = &CredentialEncodingPolicy{
SecretTypes: []CredentialType{
CredentialTypeUserPrivateKey,
},
CleartextTypes: []CredentialType{
CredentialTypeServerPublicKey,
CredentialTypeServerIdentity,
},
}
}
return &Server{Config: cfg, UserRecord: &UserRecord{}}, nil
}
// SetUserID sets the User ID for the Server's User Record.
func (s *Server) SetUserID(username []byte) error {
_, err := s.Config.RecordTable.LookupUserRecord(string(username))
if err == nil {
return common.ErrorUserAlreadyRegistered
}
s.UserRecord.UserID = username
return nil
}
// GetUserRecordFromUsername looks up the user record associated with the
// given username, and uses it to set the server's user record.
// Errors if no user record can be found, or there is no LookupUserRecord set.
func (s *Server) GetUserRecordFromUsername(username []byte) (*UserRecord, error) {
if s.Config.RecordTable == nil {
return nil, common.ErrorNoPasswordTable
}
userRecord, err := s.Config.RecordTable.LookupUserRecord(string(username))
if err != nil {
return nil, err
}
return userRecord, nil
}
// InsertNewUserRecord updates the server's user record struct with the given data,
// registers the record using the InsertUserRecord, and returns the created record.
func (s *Server) InsertNewUserRecord(userPublicKey crypto.PublicKey, envelope *Envelope) (*UserRecord, error) {
record := s.UserRecord
record.Envelope = envelope
record.UserPublicKey = userPublicKey
if s.Config.RecordTable != nil {
if err := s.Config.RecordTable.InsertUserRecord(string(record.UserID), record); err != nil {
return nil, err
}
}
return record, nil
}
// NewClient returns a new OPAQUE client.
func NewClient(userID, serverID string, suite oprf.SuiteID, signerKey crypto.Signer) (*Client, error) {
oprfClient, err := oprf.NewClient(suite)
if err != nil {
return nil, err
}
return &Client{
UserID: []byte(userID),
ServerID: []byte(serverID),
oprfState: oprfClient,
signer: signerKey,
suite: suite,
}, nil
}