v3_server.go 22 KB

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