v3_server.go 24 KB

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