v3_server.go 25 KB

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