v3_server.go 22 KB

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