v3_server.go 24 KB

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