v3_server.go 23 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786
  1. // Copyright 2015 The etcd Authors
  2. //
  3. // Licensed under the Apache License, Version 2.0 (the "License");
  4. // you may not use this file except in compliance with the License.
  5. // You may obtain a copy of the License at
  6. //
  7. // http://www.apache.org/licenses/LICENSE-2.0
  8. //
  9. // Unless required by applicable law or agreed to in writing, software
  10. // distributed under the License is distributed on an "AS IS" BASIS,
  11. // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12. // See the License for the specific language governing permissions and
  13. // limitations under the License.
  14. package etcdserver
  15. import (
  16. "bytes"
  17. "context"
  18. "encoding/binary"
  19. "time"
  20. "go.etcd.io/etcd/auth"
  21. "go.etcd.io/etcd/etcdserver/api/membership"
  22. pb "go.etcd.io/etcd/etcdserver/etcdserverpb"
  23. "go.etcd.io/etcd/lease"
  24. "go.etcd.io/etcd/lease/leasehttp"
  25. "go.etcd.io/etcd/mvcc"
  26. "go.etcd.io/etcd/pkg/traceutil"
  27. "go.etcd.io/etcd/raft"
  28. "github.com/gogo/protobuf/proto"
  29. "go.uber.org/zap"
  30. )
  31. const (
  32. // In the health case, there might be a small gap (10s of entries) between
  33. // the applied index and committed index.
  34. // However, if the committed entries are very heavy to apply, the gap might grow.
  35. // We should stop accepting new proposals if the gap growing to a certain point.
  36. maxGapBetweenApplyAndCommitIndex = 5000
  37. )
  38. type RaftKV interface {
  39. Range(ctx context.Context, r *pb.RangeRequest) (*pb.RangeResponse, error)
  40. Put(ctx context.Context, r *pb.PutRequest) (*pb.PutResponse, error)
  41. DeleteRange(ctx context.Context, r *pb.DeleteRangeRequest) (*pb.DeleteRangeResponse, error)
  42. Txn(ctx context.Context, r *pb.TxnRequest) (*pb.TxnResponse, error)
  43. Compact(ctx context.Context, r *pb.CompactionRequest) (*pb.CompactionResponse, error)
  44. }
  45. type Lessor interface {
  46. // LeaseGrant sends LeaseGrant request to raft and apply it after committed.
  47. LeaseGrant(ctx context.Context, r *pb.LeaseGrantRequest) (*pb.LeaseGrantResponse, error)
  48. // LeaseRevoke sends LeaseRevoke request to raft and apply it after committed.
  49. LeaseRevoke(ctx context.Context, r *pb.LeaseRevokeRequest) (*pb.LeaseRevokeResponse, error)
  50. // LeaseRenew renews the lease with given ID. The renewed TTL is returned. Or an error
  51. // is returned.
  52. LeaseRenew(ctx context.Context, id lease.LeaseID) (int64, error)
  53. // LeaseTimeToLive retrieves lease information.
  54. LeaseTimeToLive(ctx context.Context, r *pb.LeaseTimeToLiveRequest) (*pb.LeaseTimeToLiveResponse, error)
  55. // LeaseLeases lists all leases.
  56. LeaseLeases(ctx context.Context, r *pb.LeaseLeasesRequest) (*pb.LeaseLeasesResponse, error)
  57. }
  58. type Authenticator interface {
  59. AuthEnable(ctx context.Context, r *pb.AuthEnableRequest) (*pb.AuthEnableResponse, error)
  60. AuthDisable(ctx context.Context, r *pb.AuthDisableRequest) (*pb.AuthDisableResponse, error)
  61. Authenticate(ctx context.Context, r *pb.AuthenticateRequest) (*pb.AuthenticateResponse, error)
  62. UserAdd(ctx context.Context, r *pb.AuthUserAddRequest) (*pb.AuthUserAddResponse, error)
  63. UserDelete(ctx context.Context, r *pb.AuthUserDeleteRequest) (*pb.AuthUserDeleteResponse, error)
  64. UserChangePassword(ctx context.Context, r *pb.AuthUserChangePasswordRequest) (*pb.AuthUserChangePasswordResponse, error)
  65. UserGrantRole(ctx context.Context, r *pb.AuthUserGrantRoleRequest) (*pb.AuthUserGrantRoleResponse, error)
  66. UserGet(ctx context.Context, r *pb.AuthUserGetRequest) (*pb.AuthUserGetResponse, error)
  67. UserRevokeRole(ctx context.Context, r *pb.AuthUserRevokeRoleRequest) (*pb.AuthUserRevokeRoleResponse, error)
  68. RoleAdd(ctx context.Context, r *pb.AuthRoleAddRequest) (*pb.AuthRoleAddResponse, error)
  69. RoleGrantPermission(ctx context.Context, r *pb.AuthRoleGrantPermissionRequest) (*pb.AuthRoleGrantPermissionResponse, error)
  70. RoleGet(ctx context.Context, r *pb.AuthRoleGetRequest) (*pb.AuthRoleGetResponse, error)
  71. RoleRevokePermission(ctx context.Context, r *pb.AuthRoleRevokePermissionRequest) (*pb.AuthRoleRevokePermissionResponse, error)
  72. RoleDelete(ctx context.Context, r *pb.AuthRoleDeleteRequest) (*pb.AuthRoleDeleteResponse, error)
  73. UserList(ctx context.Context, r *pb.AuthUserListRequest) (*pb.AuthUserListResponse, error)
  74. RoleList(ctx context.Context, r *pb.AuthRoleListRequest) (*pb.AuthRoleListResponse, error)
  75. }
  76. func (s *EtcdServer) Range(ctx context.Context, r *pb.RangeRequest) (*pb.RangeResponse, error) {
  77. trace := traceutil.New("range",
  78. s.getLogger(),
  79. traceutil.Field{Key: "range_begin", Value: string(r.Key)},
  80. traceutil.Field{Key: "range_end", Value: string(r.RangeEnd)},
  81. )
  82. ctx = context.WithValue(ctx, traceutil.CtxKey, trace)
  83. var resp *pb.RangeResponse
  84. var err error
  85. defer func(start time.Time) {
  86. warnOfExpensiveReadOnlyRangeRequest(s.getLogger(), start, r, resp, err)
  87. if resp != nil {
  88. trace.AddField(
  89. traceutil.Field{Key: "response_count", Value: len(resp.Kvs)},
  90. traceutil.Field{Key: "response_revision", Value: resp.Header.Revision},
  91. )
  92. }
  93. trace.LogIfLong(rangeTraceThreshold)
  94. }(time.Now())
  95. if !r.Serializable {
  96. err = s.linearizableReadNotify(ctx)
  97. trace.Step("agreement among raft nodes before linearized reading")
  98. if err != nil {
  99. return nil, err
  100. }
  101. }
  102. chk := func(ai *auth.AuthInfo) error {
  103. return s.authStore.IsRangePermitted(ai, r.Key, r.RangeEnd)
  104. }
  105. get := func() { resp, err = s.applyV3Base.Range(ctx, nil, r) }
  106. if serr := s.doSerialize(ctx, chk, get); serr != nil {
  107. err = serr
  108. return nil, err
  109. }
  110. return resp, err
  111. }
  112. func (s *EtcdServer) Put(ctx context.Context, r *pb.PutRequest) (*pb.PutResponse, error) {
  113. resp, err := s.raftRequest(ctx, pb.InternalRaftRequest{Put: r})
  114. if err != nil {
  115. return nil, err
  116. }
  117. return resp.(*pb.PutResponse), nil
  118. }
  119. func (s *EtcdServer) DeleteRange(ctx context.Context, r *pb.DeleteRangeRequest) (*pb.DeleteRangeResponse, error) {
  120. resp, err := s.raftRequest(ctx, pb.InternalRaftRequest{DeleteRange: r})
  121. if err != nil {
  122. return nil, err
  123. }
  124. return resp.(*pb.DeleteRangeResponse), nil
  125. }
  126. func (s *EtcdServer) Txn(ctx context.Context, r *pb.TxnRequest) (*pb.TxnResponse, error) {
  127. if isTxnReadonly(r) {
  128. if !isTxnSerializable(r) {
  129. err := s.linearizableReadNotify(ctx)
  130. if err != nil {
  131. return nil, err
  132. }
  133. }
  134. var resp *pb.TxnResponse
  135. var err error
  136. chk := func(ai *auth.AuthInfo) error {
  137. return checkTxnAuth(s.authStore, ai, r)
  138. }
  139. defer func(start time.Time) {
  140. warnOfExpensiveReadOnlyTxnRequest(s.getLogger(), start, r, resp, err)
  141. }(time.Now())
  142. get := func() { resp, err = s.applyV3Base.Txn(r) }
  143. if serr := s.doSerialize(ctx, chk, get); serr != nil {
  144. return nil, serr
  145. }
  146. return resp, err
  147. }
  148. resp, err := s.raftRequest(ctx, pb.InternalRaftRequest{Txn: r})
  149. if err != nil {
  150. return nil, err
  151. }
  152. return resp.(*pb.TxnResponse), nil
  153. }
  154. func isTxnSerializable(r *pb.TxnRequest) bool {
  155. for _, u := range r.Success {
  156. if r := u.GetRequestRange(); r == nil || !r.Serializable {
  157. return false
  158. }
  159. }
  160. for _, u := range r.Failure {
  161. if r := u.GetRequestRange(); r == nil || !r.Serializable {
  162. return false
  163. }
  164. }
  165. return true
  166. }
  167. func isTxnReadonly(r *pb.TxnRequest) bool {
  168. for _, u := range r.Success {
  169. if r := u.GetRequestRange(); r == nil {
  170. return false
  171. }
  172. }
  173. for _, u := range r.Failure {
  174. if r := u.GetRequestRange(); r == nil {
  175. return false
  176. }
  177. }
  178. return true
  179. }
  180. func (s *EtcdServer) Compact(ctx context.Context, r *pb.CompactionRequest) (*pb.CompactionResponse, error) {
  181. result, err := s.processInternalRaftRequestOnce(ctx, pb.InternalRaftRequest{Compaction: r})
  182. if r.Physical && result != nil && result.physc != nil {
  183. <-result.physc
  184. // The compaction is done deleting keys; the hash is now settled
  185. // but the data is not necessarily committed. If there's a crash,
  186. // the hash may revert to a hash prior to compaction completing
  187. // if the compaction resumes. Force the finished compaction to
  188. // commit so it won't resume following a crash.
  189. s.be.ForceCommit()
  190. }
  191. if err != nil {
  192. return nil, err
  193. }
  194. if result.err != nil {
  195. return nil, result.err
  196. }
  197. resp := result.resp.(*pb.CompactionResponse)
  198. if resp == nil {
  199. resp = &pb.CompactionResponse{}
  200. }
  201. if resp.Header == nil {
  202. resp.Header = &pb.ResponseHeader{}
  203. }
  204. resp.Header.Revision = s.kv.Rev()
  205. return resp, nil
  206. }
  207. func (s *EtcdServer) LeaseGrant(ctx context.Context, r *pb.LeaseGrantRequest) (*pb.LeaseGrantResponse, error) {
  208. // no id given? choose one
  209. for r.ID == int64(lease.NoLease) {
  210. // only use positive int64 id's
  211. r.ID = int64(s.reqIDGen.Next() & ((1 << 63) - 1))
  212. }
  213. resp, err := s.raftRequestOnce(ctx, pb.InternalRaftRequest{LeaseGrant: r})
  214. if err != nil {
  215. return nil, err
  216. }
  217. return resp.(*pb.LeaseGrantResponse), nil
  218. }
  219. func (s *EtcdServer) LeaseRevoke(ctx context.Context, r *pb.LeaseRevokeRequest) (*pb.LeaseRevokeResponse, error) {
  220. resp, err := s.raftRequestOnce(ctx, pb.InternalRaftRequest{LeaseRevoke: r})
  221. if err != nil {
  222. return nil, err
  223. }
  224. return resp.(*pb.LeaseRevokeResponse), nil
  225. }
  226. func (s *EtcdServer) LeaseRenew(ctx context.Context, id lease.LeaseID) (int64, error) {
  227. ttl, err := s.lessor.Renew(id)
  228. if err == nil { // already requested to primary lessor(leader)
  229. return ttl, nil
  230. }
  231. if err != lease.ErrNotPrimary {
  232. return -1, err
  233. }
  234. cctx, cancel := context.WithTimeout(ctx, s.Cfg.ReqTimeout())
  235. defer cancel()
  236. // renewals don't go through raft; forward to leader manually
  237. for cctx.Err() == nil && err != nil {
  238. leader, lerr := s.waitLeader(cctx)
  239. if lerr != nil {
  240. return -1, lerr
  241. }
  242. for _, url := range leader.PeerURLs {
  243. lurl := url + leasehttp.LeasePrefix
  244. ttl, err = leasehttp.RenewHTTP(cctx, id, lurl, s.peerRt)
  245. if err == nil || err == lease.ErrLeaseNotFound {
  246. return ttl, err
  247. }
  248. }
  249. }
  250. if cctx.Err() == context.DeadlineExceeded {
  251. return -1, ErrTimeout
  252. }
  253. return -1, ErrCanceled
  254. }
  255. func (s *EtcdServer) LeaseTimeToLive(ctx context.Context, r *pb.LeaseTimeToLiveRequest) (*pb.LeaseTimeToLiveResponse, error) {
  256. if s.Leader() == s.ID() {
  257. // primary; timetolive directly from leader
  258. le := s.lessor.Lookup(lease.LeaseID(r.ID))
  259. if le == nil {
  260. return nil, lease.ErrLeaseNotFound
  261. }
  262. // TODO: fill out ResponseHeader
  263. resp := &pb.LeaseTimeToLiveResponse{Header: &pb.ResponseHeader{}, ID: r.ID, TTL: int64(le.Remaining().Seconds()), GrantedTTL: le.TTL()}
  264. if r.Keys {
  265. ks := le.Keys()
  266. kbs := make([][]byte, len(ks))
  267. for i := range ks {
  268. kbs[i] = []byte(ks[i])
  269. }
  270. resp.Keys = kbs
  271. }
  272. return resp, nil
  273. }
  274. cctx, cancel := context.WithTimeout(ctx, s.Cfg.ReqTimeout())
  275. defer cancel()
  276. // forward to leader
  277. for cctx.Err() == nil {
  278. leader, err := s.waitLeader(cctx)
  279. if err != nil {
  280. return nil, err
  281. }
  282. for _, url := range leader.PeerURLs {
  283. lurl := url + leasehttp.LeaseInternalPrefix
  284. resp, err := leasehttp.TimeToLiveHTTP(cctx, lease.LeaseID(r.ID), r.Keys, lurl, s.peerRt)
  285. if err == nil {
  286. return resp.LeaseTimeToLiveResponse, nil
  287. }
  288. if err == lease.ErrLeaseNotFound {
  289. return nil, err
  290. }
  291. }
  292. }
  293. if cctx.Err() == context.DeadlineExceeded {
  294. return nil, ErrTimeout
  295. }
  296. return nil, ErrCanceled
  297. }
  298. func (s *EtcdServer) LeaseLeases(ctx context.Context, r *pb.LeaseLeasesRequest) (*pb.LeaseLeasesResponse, error) {
  299. ls := s.lessor.Leases()
  300. lss := make([]*pb.LeaseStatus, len(ls))
  301. for i := range ls {
  302. lss[i] = &pb.LeaseStatus{ID: int64(ls[i].ID)}
  303. }
  304. return &pb.LeaseLeasesResponse{Header: newHeader(s), Leases: lss}, nil
  305. }
  306. func (s *EtcdServer) waitLeader(ctx context.Context) (*membership.Member, error) {
  307. leader := s.cluster.Member(s.Leader())
  308. for leader == nil {
  309. // wait an election
  310. dur := time.Duration(s.Cfg.ElectionTicks) * time.Duration(s.Cfg.TickMs) * time.Millisecond
  311. select {
  312. case <-time.After(dur):
  313. leader = s.cluster.Member(s.Leader())
  314. case <-s.stopping:
  315. return nil, ErrStopped
  316. case <-ctx.Done():
  317. return nil, ErrNoLeader
  318. }
  319. }
  320. if leader == nil || len(leader.PeerURLs) == 0 {
  321. return nil, ErrNoLeader
  322. }
  323. return leader, nil
  324. }
  325. func (s *EtcdServer) Alarm(ctx context.Context, r *pb.AlarmRequest) (*pb.AlarmResponse, error) {
  326. resp, err := s.raftRequestOnce(ctx, pb.InternalRaftRequest{Alarm: r})
  327. if err != nil {
  328. return nil, err
  329. }
  330. return resp.(*pb.AlarmResponse), nil
  331. }
  332. func (s *EtcdServer) AuthEnable(ctx context.Context, r *pb.AuthEnableRequest) (*pb.AuthEnableResponse, error) {
  333. resp, err := s.raftRequestOnce(ctx, pb.InternalRaftRequest{AuthEnable: r})
  334. if err != nil {
  335. return nil, err
  336. }
  337. return resp.(*pb.AuthEnableResponse), nil
  338. }
  339. func (s *EtcdServer) AuthDisable(ctx context.Context, r *pb.AuthDisableRequest) (*pb.AuthDisableResponse, error) {
  340. resp, err := s.raftRequest(ctx, pb.InternalRaftRequest{AuthDisable: r})
  341. if err != nil {
  342. return nil, err
  343. }
  344. return resp.(*pb.AuthDisableResponse), nil
  345. }
  346. func (s *EtcdServer) Authenticate(ctx context.Context, r *pb.AuthenticateRequest) (*pb.AuthenticateResponse, error) {
  347. if err := s.linearizableReadNotify(ctx); err != nil {
  348. return nil, err
  349. }
  350. lg := s.getLogger()
  351. var resp proto.Message
  352. for {
  353. checkedRevision, err := s.AuthStore().CheckPassword(r.Name, r.Password)
  354. if err != nil {
  355. if err != auth.ErrAuthNotEnabled {
  356. if lg != nil {
  357. lg.Warn(
  358. "invalid authentication was requested",
  359. zap.String("user", r.Name),
  360. zap.Error(err),
  361. )
  362. } else {
  363. plog.Errorf("invalid authentication request to user %s was issued", r.Name)
  364. }
  365. }
  366. return nil, err
  367. }
  368. st, err := s.AuthStore().GenTokenPrefix()
  369. if err != nil {
  370. return nil, err
  371. }
  372. internalReq := &pb.InternalAuthenticateRequest{
  373. Name: r.Name,
  374. Password: r.Password,
  375. SimpleToken: st,
  376. }
  377. resp, err = s.raftRequestOnce(ctx, pb.InternalRaftRequest{Authenticate: internalReq})
  378. if err != nil {
  379. return nil, err
  380. }
  381. if checkedRevision == s.AuthStore().Revision() {
  382. break
  383. }
  384. if lg != nil {
  385. lg.Info("revision when password checked became stale; retrying")
  386. } else {
  387. plog.Infof("revision when password checked is obsolete, retrying")
  388. }
  389. }
  390. return resp.(*pb.AuthenticateResponse), nil
  391. }
  392. func (s *EtcdServer) UserAdd(ctx context.Context, r *pb.AuthUserAddRequest) (*pb.AuthUserAddResponse, error) {
  393. resp, err := s.raftRequest(ctx, pb.InternalRaftRequest{AuthUserAdd: r})
  394. if err != nil {
  395. return nil, err
  396. }
  397. return resp.(*pb.AuthUserAddResponse), nil
  398. }
  399. func (s *EtcdServer) UserDelete(ctx context.Context, r *pb.AuthUserDeleteRequest) (*pb.AuthUserDeleteResponse, error) {
  400. resp, err := s.raftRequest(ctx, pb.InternalRaftRequest{AuthUserDelete: r})
  401. if err != nil {
  402. return nil, err
  403. }
  404. return resp.(*pb.AuthUserDeleteResponse), nil
  405. }
  406. func (s *EtcdServer) UserChangePassword(ctx context.Context, r *pb.AuthUserChangePasswordRequest) (*pb.AuthUserChangePasswordResponse, error) {
  407. resp, err := s.raftRequest(ctx, pb.InternalRaftRequest{AuthUserChangePassword: r})
  408. if err != nil {
  409. return nil, err
  410. }
  411. return resp.(*pb.AuthUserChangePasswordResponse), nil
  412. }
  413. func (s *EtcdServer) UserGrantRole(ctx context.Context, r *pb.AuthUserGrantRoleRequest) (*pb.AuthUserGrantRoleResponse, error) {
  414. resp, err := s.raftRequest(ctx, pb.InternalRaftRequest{AuthUserGrantRole: r})
  415. if err != nil {
  416. return nil, err
  417. }
  418. return resp.(*pb.AuthUserGrantRoleResponse), nil
  419. }
  420. func (s *EtcdServer) UserGet(ctx context.Context, r *pb.AuthUserGetRequest) (*pb.AuthUserGetResponse, error) {
  421. resp, err := s.raftRequest(ctx, pb.InternalRaftRequest{AuthUserGet: r})
  422. if err != nil {
  423. return nil, err
  424. }
  425. return resp.(*pb.AuthUserGetResponse), nil
  426. }
  427. func (s *EtcdServer) UserList(ctx context.Context, r *pb.AuthUserListRequest) (*pb.AuthUserListResponse, error) {
  428. resp, err := s.raftRequest(ctx, pb.InternalRaftRequest{AuthUserList: r})
  429. if err != nil {
  430. return nil, err
  431. }
  432. return resp.(*pb.AuthUserListResponse), nil
  433. }
  434. func (s *EtcdServer) UserRevokeRole(ctx context.Context, r *pb.AuthUserRevokeRoleRequest) (*pb.AuthUserRevokeRoleResponse, error) {
  435. resp, err := s.raftRequest(ctx, pb.InternalRaftRequest{AuthUserRevokeRole: r})
  436. if err != nil {
  437. return nil, err
  438. }
  439. return resp.(*pb.AuthUserRevokeRoleResponse), nil
  440. }
  441. func (s *EtcdServer) RoleAdd(ctx context.Context, r *pb.AuthRoleAddRequest) (*pb.AuthRoleAddResponse, error) {
  442. resp, err := s.raftRequest(ctx, pb.InternalRaftRequest{AuthRoleAdd: r})
  443. if err != nil {
  444. return nil, err
  445. }
  446. return resp.(*pb.AuthRoleAddResponse), nil
  447. }
  448. func (s *EtcdServer) RoleGrantPermission(ctx context.Context, r *pb.AuthRoleGrantPermissionRequest) (*pb.AuthRoleGrantPermissionResponse, error) {
  449. resp, err := s.raftRequest(ctx, pb.InternalRaftRequest{AuthRoleGrantPermission: r})
  450. if err != nil {
  451. return nil, err
  452. }
  453. return resp.(*pb.AuthRoleGrantPermissionResponse), nil
  454. }
  455. func (s *EtcdServer) RoleGet(ctx context.Context, r *pb.AuthRoleGetRequest) (*pb.AuthRoleGetResponse, error) {
  456. resp, err := s.raftRequest(ctx, pb.InternalRaftRequest{AuthRoleGet: r})
  457. if err != nil {
  458. return nil, err
  459. }
  460. return resp.(*pb.AuthRoleGetResponse), nil
  461. }
  462. func (s *EtcdServer) RoleList(ctx context.Context, r *pb.AuthRoleListRequest) (*pb.AuthRoleListResponse, error) {
  463. resp, err := s.raftRequest(ctx, pb.InternalRaftRequest{AuthRoleList: r})
  464. if err != nil {
  465. return nil, err
  466. }
  467. return resp.(*pb.AuthRoleListResponse), nil
  468. }
  469. func (s *EtcdServer) RoleRevokePermission(ctx context.Context, r *pb.AuthRoleRevokePermissionRequest) (*pb.AuthRoleRevokePermissionResponse, error) {
  470. resp, err := s.raftRequest(ctx, pb.InternalRaftRequest{AuthRoleRevokePermission: r})
  471. if err != nil {
  472. return nil, err
  473. }
  474. return resp.(*pb.AuthRoleRevokePermissionResponse), nil
  475. }
  476. func (s *EtcdServer) RoleDelete(ctx context.Context, r *pb.AuthRoleDeleteRequest) (*pb.AuthRoleDeleteResponse, error) {
  477. resp, err := s.raftRequest(ctx, pb.InternalRaftRequest{AuthRoleDelete: r})
  478. if err != nil {
  479. return nil, err
  480. }
  481. return resp.(*pb.AuthRoleDeleteResponse), nil
  482. }
  483. func (s *EtcdServer) raftRequestOnce(ctx context.Context, r pb.InternalRaftRequest) (proto.Message, error) {
  484. result, err := s.processInternalRaftRequestOnce(ctx, r)
  485. if err != nil {
  486. return nil, err
  487. }
  488. if result.err != nil {
  489. return nil, result.err
  490. }
  491. return result.resp, nil
  492. }
  493. func (s *EtcdServer) raftRequest(ctx context.Context, r pb.InternalRaftRequest) (proto.Message, error) {
  494. for {
  495. resp, err := s.raftRequestOnce(ctx, r)
  496. if err != auth.ErrAuthOldRevision {
  497. return resp, err
  498. }
  499. }
  500. }
  501. // doSerialize handles the auth logic, with permissions checked by "chk", for a serialized request "get". Returns a non-nil error on authentication failure.
  502. func (s *EtcdServer) doSerialize(ctx context.Context, chk func(*auth.AuthInfo) error, get func()) error {
  503. trace := traceutil.Get(ctx)
  504. ai, err := s.AuthInfoFromCtx(ctx)
  505. if err != nil {
  506. return err
  507. }
  508. if ai == nil {
  509. // chk expects non-nil AuthInfo; use empty credentials
  510. ai = &auth.AuthInfo{}
  511. }
  512. if err = chk(ai); err != nil {
  513. return err
  514. }
  515. trace.Step("get authentication metadata")
  516. // fetch response for serialized request
  517. get()
  518. // check for stale token revision in case the auth store was updated while
  519. // the request has been handled.
  520. if ai.Revision != 0 && ai.Revision != s.authStore.Revision() {
  521. return auth.ErrAuthOldRevision
  522. }
  523. return nil
  524. }
  525. func (s *EtcdServer) processInternalRaftRequestOnce(ctx context.Context, r pb.InternalRaftRequest) (*applyResult, error) {
  526. ai := s.getAppliedIndex()
  527. ci := s.getCommittedIndex()
  528. if ci > ai+maxGapBetweenApplyAndCommitIndex {
  529. return nil, ErrTooManyRequests
  530. }
  531. r.Header = &pb.RequestHeader{
  532. ID: s.reqIDGen.Next(),
  533. }
  534. authInfo, err := s.AuthInfoFromCtx(ctx)
  535. if err != nil {
  536. return nil, err
  537. }
  538. if authInfo != nil {
  539. r.Header.Username = authInfo.Username
  540. r.Header.AuthRevision = authInfo.Revision
  541. }
  542. data, err := r.Marshal()
  543. if err != nil {
  544. return nil, err
  545. }
  546. if len(data) > int(s.Cfg.MaxRequestBytes) {
  547. return nil, ErrRequestTooLarge
  548. }
  549. id := r.ID
  550. if id == 0 {
  551. id = r.Header.ID
  552. }
  553. ch := s.w.Register(id)
  554. cctx, cancel := context.WithTimeout(ctx, s.Cfg.ReqTimeout())
  555. defer cancel()
  556. start := time.Now()
  557. err = s.r.Propose(cctx, data)
  558. if err != nil {
  559. proposalsFailed.Inc()
  560. s.w.Trigger(id, nil) // GC wait
  561. return nil, err
  562. }
  563. proposalsPending.Inc()
  564. defer proposalsPending.Dec()
  565. select {
  566. case x := <-ch:
  567. return x.(*applyResult), nil
  568. case <-cctx.Done():
  569. proposalsFailed.Inc()
  570. s.w.Trigger(id, nil) // GC wait
  571. return nil, s.parseProposeCtxErr(cctx.Err(), start)
  572. case <-s.done:
  573. return nil, ErrStopped
  574. }
  575. }
  576. // Watchable returns a watchable interface attached to the etcdserver.
  577. func (s *EtcdServer) Watchable() mvcc.WatchableKV { return s.KV() }
  578. func (s *EtcdServer) linearizableReadLoop() {
  579. var rs raft.ReadState
  580. for {
  581. ctxToSend := make([]byte, 8)
  582. id1 := s.reqIDGen.Next()
  583. binary.BigEndian.PutUint64(ctxToSend, id1)
  584. leaderChangedNotifier := s.leaderChangedNotify()
  585. select {
  586. case <-leaderChangedNotifier:
  587. continue
  588. case <-s.readwaitc:
  589. case <-s.stopping:
  590. return
  591. }
  592. nextnr := newNotifier()
  593. s.readMu.Lock()
  594. nr := s.readNotifier
  595. s.readNotifier = nextnr
  596. s.readMu.Unlock()
  597. lg := s.getLogger()
  598. cctx, cancel := context.WithTimeout(context.Background(), s.Cfg.ReqTimeout())
  599. if err := s.r.ReadIndex(cctx, ctxToSend); err != nil {
  600. cancel()
  601. if err == raft.ErrStopped {
  602. return
  603. }
  604. if lg != nil {
  605. lg.Warn("failed to get read index from Raft", zap.Error(err))
  606. } else {
  607. plog.Errorf("failed to get read index from raft: %v", err)
  608. }
  609. readIndexFailed.Inc()
  610. nr.notify(err)
  611. continue
  612. }
  613. cancel()
  614. var (
  615. timeout bool
  616. done bool
  617. )
  618. for !timeout && !done {
  619. select {
  620. case rs = <-s.r.readStateC:
  621. done = bytes.Equal(rs.RequestCtx, ctxToSend)
  622. if !done {
  623. // a previous request might time out. now we should ignore the response of it and
  624. // continue waiting for the response of the current requests.
  625. id2 := uint64(0)
  626. if len(rs.RequestCtx) == 8 {
  627. id2 = binary.BigEndian.Uint64(rs.RequestCtx)
  628. }
  629. if lg != nil {
  630. lg.Warn(
  631. "ignored out-of-date read index response; local node read indexes queueing up and waiting to be in sync with leader",
  632. zap.Uint64("sent-request-id", id1),
  633. zap.Uint64("received-request-id", id2),
  634. )
  635. } else {
  636. plog.Warningf("ignored out-of-date read index response; local node read indexes queueing up and waiting to be in sync with leader (request ID want %d, got %d)", id1, id2)
  637. }
  638. slowReadIndex.Inc()
  639. }
  640. case <-leaderChangedNotifier:
  641. timeout = true
  642. readIndexFailed.Inc()
  643. // return a retryable error.
  644. nr.notify(ErrLeaderChanged)
  645. case <-time.After(s.Cfg.ReqTimeout()):
  646. if lg != nil {
  647. lg.Warn("timed out waiting for read index response (local node might have slow network)", zap.Duration("timeout", s.Cfg.ReqTimeout()))
  648. } else {
  649. plog.Warningf("timed out waiting for read index response (local node might have slow network)")
  650. }
  651. nr.notify(ErrTimeout)
  652. timeout = true
  653. slowReadIndex.Inc()
  654. case <-s.stopping:
  655. return
  656. }
  657. }
  658. if !done {
  659. continue
  660. }
  661. if ai := s.getAppliedIndex(); ai < rs.Index {
  662. select {
  663. case <-s.applyWait.Wait(rs.Index):
  664. case <-s.stopping:
  665. return
  666. }
  667. }
  668. // unblock all l-reads requested at indices before rs.Index
  669. nr.notify(nil)
  670. }
  671. }
  672. func (s *EtcdServer) linearizableReadNotify(ctx context.Context) error {
  673. s.readMu.RLock()
  674. nc := s.readNotifier
  675. s.readMu.RUnlock()
  676. // signal linearizable loop for current notify if it hasn't been already
  677. select {
  678. case s.readwaitc <- struct{}{}:
  679. default:
  680. }
  681. // wait for read state notification
  682. select {
  683. case <-nc.c:
  684. return nc.err
  685. case <-ctx.Done():
  686. return ctx.Err()
  687. case <-s.done:
  688. return ErrStopped
  689. }
  690. }
  691. func (s *EtcdServer) AuthInfoFromCtx(ctx context.Context) (*auth.AuthInfo, error) {
  692. authInfo, err := s.AuthStore().AuthInfoFromCtx(ctx)
  693. if authInfo != nil || err != nil {
  694. return authInfo, err
  695. }
  696. if !s.Cfg.ClientCertAuthEnabled {
  697. return nil, nil
  698. }
  699. authInfo = s.AuthStore().AuthInfoFromTLS(ctx)
  700. return authInfo, nil
  701. }