v3_server.go 22 KB

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