v3_server.go 23 KB

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