v3_server.go 24 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834
  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. // TODO: remove this checking when we release etcd 3.2
  151. if s.ClusterVersion() == nil || s.ClusterVersion().LessThan(newRangeClusterVersion) {
  152. return s.legacyTxn(ctx, r)
  153. }
  154. if isTxnReadonly(r) {
  155. if !isTxnSerializable(r) {
  156. err := s.linearizableReadNotify(ctx)
  157. if err != nil {
  158. return nil, err
  159. }
  160. }
  161. var resp *pb.TxnResponse
  162. var err error
  163. chk := func(ai *auth.AuthInfo) error {
  164. return checkTxnAuth(s.authStore, ai, r)
  165. }
  166. get := func() { resp, err = s.applyV3Base.Txn(r) }
  167. if serr := s.doSerialize(ctx, chk, get); serr != nil {
  168. return nil, serr
  169. }
  170. return resp, err
  171. }
  172. result, err := s.processInternalRaftRequest(ctx, pb.InternalRaftRequest{Txn: r})
  173. if err != nil {
  174. return nil, err
  175. }
  176. if result.err != nil {
  177. return nil, result.err
  178. }
  179. return result.resp.(*pb.TxnResponse), nil
  180. }
  181. // TODO: remove this func when we release etcd 3.2
  182. func (s *EtcdServer) legacyTxn(ctx context.Context, r *pb.TxnRequest) (*pb.TxnResponse, error) {
  183. if isTxnSerializable(r) {
  184. var resp *pb.TxnResponse
  185. var err error
  186. chk := func(ai *auth.AuthInfo) error {
  187. return checkTxnAuth(s.authStore, ai, r)
  188. }
  189. get := func() { resp, err = s.applyV3Base.Txn(r) }
  190. if serr := s.doSerialize(ctx, chk, get); serr != nil {
  191. return nil, serr
  192. }
  193. return resp, err
  194. }
  195. result, err := s.processInternalRaftRequest(ctx, pb.InternalRaftRequest{Txn: r})
  196. if err != nil {
  197. return nil, err
  198. }
  199. if result.err != nil {
  200. return nil, result.err
  201. }
  202. return result.resp.(*pb.TxnResponse), nil
  203. }
  204. func isTxnSerializable(r *pb.TxnRequest) bool {
  205. for _, u := range r.Success {
  206. if r := u.GetRequestRange(); r == nil || !r.Serializable {
  207. return false
  208. }
  209. }
  210. for _, u := range r.Failure {
  211. if r := u.GetRequestRange(); r == nil || !r.Serializable {
  212. return false
  213. }
  214. }
  215. return true
  216. }
  217. func isTxnReadonly(r *pb.TxnRequest) bool {
  218. for _, u := range r.Success {
  219. if r := u.GetRequestRange(); r == nil {
  220. return false
  221. }
  222. }
  223. for _, u := range r.Failure {
  224. if r := u.GetRequestRange(); r == nil {
  225. return false
  226. }
  227. }
  228. return true
  229. }
  230. func (s *EtcdServer) Compact(ctx context.Context, r *pb.CompactionRequest) (*pb.CompactionResponse, error) {
  231. result, err := s.processInternalRaftRequestOnce(ctx, pb.InternalRaftRequest{Compaction: r})
  232. if r.Physical && result != nil && result.physc != nil {
  233. <-result.physc
  234. // The compaction is done deleting keys; the hash is now settled
  235. // but the data is not necessarily committed. If there's a crash,
  236. // the hash may revert to a hash prior to compaction completing
  237. // if the compaction resumes. Force the finished compaction to
  238. // commit so it won't resume following a crash.
  239. s.be.ForceCommit()
  240. }
  241. if err != nil {
  242. return nil, err
  243. }
  244. if result.err != nil {
  245. return nil, result.err
  246. }
  247. resp := result.resp.(*pb.CompactionResponse)
  248. if resp == nil {
  249. resp = &pb.CompactionResponse{}
  250. }
  251. if resp.Header == nil {
  252. resp.Header = &pb.ResponseHeader{}
  253. }
  254. resp.Header.Revision = s.kv.Rev()
  255. return resp, nil
  256. }
  257. func (s *EtcdServer) LeaseGrant(ctx context.Context, r *pb.LeaseGrantRequest) (*pb.LeaseGrantResponse, error) {
  258. // no id given? choose one
  259. for r.ID == int64(lease.NoLease) {
  260. // only use positive int64 id's
  261. r.ID = int64(s.reqIDGen.Next() & ((1 << 63) - 1))
  262. }
  263. result, err := s.processInternalRaftRequestOnce(ctx, pb.InternalRaftRequest{LeaseGrant: r})
  264. if err != nil {
  265. return nil, err
  266. }
  267. if result.err != nil {
  268. return nil, result.err
  269. }
  270. return result.resp.(*pb.LeaseGrantResponse), nil
  271. }
  272. func (s *EtcdServer) LeaseRevoke(ctx context.Context, r *pb.LeaseRevokeRequest) (*pb.LeaseRevokeResponse, error) {
  273. result, err := s.processInternalRaftRequestOnce(ctx, pb.InternalRaftRequest{LeaseRevoke: r})
  274. if err != nil {
  275. return nil, err
  276. }
  277. if result.err != nil {
  278. return nil, result.err
  279. }
  280. return result.resp.(*pb.LeaseRevokeResponse), nil
  281. }
  282. func (s *EtcdServer) LeaseRenew(id lease.LeaseID) (int64, error) {
  283. ttl, err := s.lessor.Renew(id)
  284. if err == nil { // already requested to primary lessor(leader)
  285. return ttl, nil
  286. }
  287. if err != lease.ErrNotPrimary {
  288. return -1, err
  289. }
  290. // renewals don't go through raft; forward to leader manually
  291. leader, err := s.waitLeader()
  292. if err != nil {
  293. return -1, err
  294. }
  295. for _, url := range leader.PeerURLs {
  296. lurl := url + leasehttp.LeasePrefix
  297. ttl, err = leasehttp.RenewHTTP(id, lurl, s.peerRt, s.Cfg.peerDialTimeout())
  298. if err == nil {
  299. break
  300. }
  301. }
  302. return ttl, err
  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. // manually request to leader
  324. leader, err := s.waitLeader()
  325. if err != nil {
  326. return nil, err
  327. }
  328. for _, url := range leader.PeerURLs {
  329. lurl := url + leasehttp.LeaseInternalPrefix
  330. var iresp *leasepb.LeaseInternalResponse
  331. iresp, err = leasehttp.TimeToLiveHTTP(ctx, lease.LeaseID(r.ID), r.Keys, lurl, s.peerRt)
  332. if err == nil {
  333. return iresp.LeaseTimeToLiveResponse, nil
  334. }
  335. }
  336. return nil, err
  337. }
  338. func (s *EtcdServer) waitLeader() (*membership.Member, error) {
  339. leader := s.cluster.Member(s.Leader())
  340. for i := 0; i < 5 && leader == nil; i++ {
  341. // wait an election
  342. dur := time.Duration(s.Cfg.ElectionTicks) * time.Duration(s.Cfg.TickMs) * time.Millisecond
  343. select {
  344. case <-time.After(dur):
  345. leader = s.cluster.Member(s.Leader())
  346. case <-s.stopping:
  347. return nil, ErrStopped
  348. }
  349. }
  350. if leader == nil || len(leader.PeerURLs) == 0 {
  351. return nil, ErrNoLeader
  352. }
  353. return leader, nil
  354. }
  355. func (s *EtcdServer) Alarm(ctx context.Context, r *pb.AlarmRequest) (*pb.AlarmResponse, error) {
  356. result, err := s.processInternalRaftRequestOnce(ctx, pb.InternalRaftRequest{Alarm: r})
  357. if err != nil {
  358. return nil, err
  359. }
  360. if result.err != nil {
  361. return nil, result.err
  362. }
  363. return result.resp.(*pb.AlarmResponse), nil
  364. }
  365. func (s *EtcdServer) AuthEnable(ctx context.Context, r *pb.AuthEnableRequest) (*pb.AuthEnableResponse, error) {
  366. result, err := s.processInternalRaftRequestOnce(ctx, pb.InternalRaftRequest{AuthEnable: r})
  367. if err != nil {
  368. return nil, err
  369. }
  370. if result.err != nil {
  371. return nil, result.err
  372. }
  373. return result.resp.(*pb.AuthEnableResponse), nil
  374. }
  375. func (s *EtcdServer) AuthDisable(ctx context.Context, r *pb.AuthDisableRequest) (*pb.AuthDisableResponse, error) {
  376. result, err := s.processInternalRaftRequest(ctx, pb.InternalRaftRequest{AuthDisable: r})
  377. if err != nil {
  378. return nil, err
  379. }
  380. if result.err != nil {
  381. return nil, result.err
  382. }
  383. return result.resp.(*pb.AuthDisableResponse), nil
  384. }
  385. func (s *EtcdServer) Authenticate(ctx context.Context, r *pb.AuthenticateRequest) (*pb.AuthenticateResponse, error) {
  386. var result *applyResult
  387. for {
  388. checkedRevision, err := s.AuthStore().CheckPassword(r.Name, r.Password)
  389. if err != nil {
  390. plog.Errorf("invalid authentication request to user %s was issued", r.Name)
  391. return nil, err
  392. }
  393. st, err := s.AuthStore().GenSimpleToken()
  394. if err != nil {
  395. return nil, err
  396. }
  397. internalReq := &pb.InternalAuthenticateRequest{
  398. Name: r.Name,
  399. Password: r.Password,
  400. SimpleToken: st,
  401. }
  402. result, err = s.processInternalRaftRequestOnce(ctx, pb.InternalRaftRequest{Authenticate: internalReq})
  403. if err != nil {
  404. return nil, err
  405. }
  406. if result.err != nil {
  407. return nil, result.err
  408. }
  409. if checkedRevision != s.AuthStore().Revision() {
  410. plog.Infof("revision when password checked is obsolete, retrying")
  411. continue
  412. }
  413. break
  414. }
  415. return result.resp.(*pb.AuthenticateResponse), nil
  416. }
  417. func (s *EtcdServer) UserAdd(ctx context.Context, r *pb.AuthUserAddRequest) (*pb.AuthUserAddResponse, error) {
  418. result, err := s.processInternalRaftRequest(ctx, pb.InternalRaftRequest{AuthUserAdd: r})
  419. if err != nil {
  420. return nil, err
  421. }
  422. if result.err != nil {
  423. return nil, result.err
  424. }
  425. return result.resp.(*pb.AuthUserAddResponse), nil
  426. }
  427. func (s *EtcdServer) UserDelete(ctx context.Context, r *pb.AuthUserDeleteRequest) (*pb.AuthUserDeleteResponse, error) {
  428. result, err := s.processInternalRaftRequest(ctx, pb.InternalRaftRequest{AuthUserDelete: r})
  429. if err != nil {
  430. return nil, err
  431. }
  432. if result.err != nil {
  433. return nil, result.err
  434. }
  435. return result.resp.(*pb.AuthUserDeleteResponse), nil
  436. }
  437. func (s *EtcdServer) UserChangePassword(ctx context.Context, r *pb.AuthUserChangePasswordRequest) (*pb.AuthUserChangePasswordResponse, error) {
  438. result, err := s.processInternalRaftRequest(ctx, pb.InternalRaftRequest{AuthUserChangePassword: r})
  439. if err != nil {
  440. return nil, err
  441. }
  442. if result.err != nil {
  443. return nil, result.err
  444. }
  445. return result.resp.(*pb.AuthUserChangePasswordResponse), nil
  446. }
  447. func (s *EtcdServer) UserGrantRole(ctx context.Context, r *pb.AuthUserGrantRoleRequest) (*pb.AuthUserGrantRoleResponse, error) {
  448. result, err := s.processInternalRaftRequest(ctx, pb.InternalRaftRequest{AuthUserGrantRole: r})
  449. if err != nil {
  450. return nil, err
  451. }
  452. if result.err != nil {
  453. return nil, result.err
  454. }
  455. return result.resp.(*pb.AuthUserGrantRoleResponse), nil
  456. }
  457. func (s *EtcdServer) UserGet(ctx context.Context, r *pb.AuthUserGetRequest) (*pb.AuthUserGetResponse, error) {
  458. result, err := s.processInternalRaftRequest(ctx, pb.InternalRaftRequest{AuthUserGet: r})
  459. if err != nil {
  460. return nil, err
  461. }
  462. if result.err != nil {
  463. return nil, result.err
  464. }
  465. return result.resp.(*pb.AuthUserGetResponse), nil
  466. }
  467. func (s *EtcdServer) UserList(ctx context.Context, r *pb.AuthUserListRequest) (*pb.AuthUserListResponse, error) {
  468. result, err := s.processInternalRaftRequest(ctx, pb.InternalRaftRequest{AuthUserList: r})
  469. if err != nil {
  470. return nil, err
  471. }
  472. if result.err != nil {
  473. return nil, result.err
  474. }
  475. return result.resp.(*pb.AuthUserListResponse), nil
  476. }
  477. func (s *EtcdServer) UserRevokeRole(ctx context.Context, r *pb.AuthUserRevokeRoleRequest) (*pb.AuthUserRevokeRoleResponse, error) {
  478. result, err := s.processInternalRaftRequest(ctx, pb.InternalRaftRequest{AuthUserRevokeRole: r})
  479. if err != nil {
  480. return nil, err
  481. }
  482. if result.err != nil {
  483. return nil, result.err
  484. }
  485. return result.resp.(*pb.AuthUserRevokeRoleResponse), nil
  486. }
  487. func (s *EtcdServer) RoleAdd(ctx context.Context, r *pb.AuthRoleAddRequest) (*pb.AuthRoleAddResponse, error) {
  488. result, err := s.processInternalRaftRequest(ctx, pb.InternalRaftRequest{AuthRoleAdd: r})
  489. if err != nil {
  490. return nil, err
  491. }
  492. if result.err != nil {
  493. return nil, result.err
  494. }
  495. return result.resp.(*pb.AuthRoleAddResponse), nil
  496. }
  497. func (s *EtcdServer) RoleGrantPermission(ctx context.Context, r *pb.AuthRoleGrantPermissionRequest) (*pb.AuthRoleGrantPermissionResponse, error) {
  498. result, err := s.processInternalRaftRequest(ctx, pb.InternalRaftRequest{AuthRoleGrantPermission: r})
  499. if err != nil {
  500. return nil, err
  501. }
  502. if result.err != nil {
  503. return nil, result.err
  504. }
  505. return result.resp.(*pb.AuthRoleGrantPermissionResponse), nil
  506. }
  507. func (s *EtcdServer) RoleGet(ctx context.Context, r *pb.AuthRoleGetRequest) (*pb.AuthRoleGetResponse, error) {
  508. result, err := s.processInternalRaftRequest(ctx, pb.InternalRaftRequest{AuthRoleGet: r})
  509. if err != nil {
  510. return nil, err
  511. }
  512. if result.err != nil {
  513. return nil, result.err
  514. }
  515. return result.resp.(*pb.AuthRoleGetResponse), nil
  516. }
  517. func (s *EtcdServer) RoleList(ctx context.Context, r *pb.AuthRoleListRequest) (*pb.AuthRoleListResponse, error) {
  518. result, err := s.processInternalRaftRequest(ctx, pb.InternalRaftRequest{AuthRoleList: r})
  519. if err != nil {
  520. return nil, err
  521. }
  522. if result.err != nil {
  523. return nil, result.err
  524. }
  525. return result.resp.(*pb.AuthRoleListResponse), nil
  526. }
  527. func (s *EtcdServer) RoleRevokePermission(ctx context.Context, r *pb.AuthRoleRevokePermissionRequest) (*pb.AuthRoleRevokePermissionResponse, error) {
  528. result, err := s.processInternalRaftRequest(ctx, pb.InternalRaftRequest{AuthRoleRevokePermission: r})
  529. if err != nil {
  530. return nil, err
  531. }
  532. if result.err != nil {
  533. return nil, result.err
  534. }
  535. return result.resp.(*pb.AuthRoleRevokePermissionResponse), nil
  536. }
  537. func (s *EtcdServer) RoleDelete(ctx context.Context, r *pb.AuthRoleDeleteRequest) (*pb.AuthRoleDeleteResponse, error) {
  538. result, err := s.processInternalRaftRequest(ctx, pb.InternalRaftRequest{AuthRoleDelete: r})
  539. if err != nil {
  540. return nil, err
  541. }
  542. if result.err != nil {
  543. return nil, result.err
  544. }
  545. return result.resp.(*pb.AuthRoleDeleteResponse), nil
  546. }
  547. func (s *EtcdServer) isValidSimpleToken(token string) bool {
  548. splitted := strings.Split(token, ".")
  549. if len(splitted) != 2 {
  550. return false
  551. }
  552. index, err := strconv.Atoi(splitted[1])
  553. if err != nil {
  554. return false
  555. }
  556. select {
  557. case <-s.applyWait.Wait(uint64(index)):
  558. return true
  559. case <-s.stop:
  560. return true
  561. }
  562. }
  563. func (s *EtcdServer) authInfoFromCtx(ctx context.Context) (*auth.AuthInfo, error) {
  564. md, ok := metadata.FromContext(ctx)
  565. if !ok {
  566. return nil, nil
  567. }
  568. ts, tok := md["token"]
  569. if !tok {
  570. return nil, nil
  571. }
  572. token := ts[0]
  573. if !s.isValidSimpleToken(token) {
  574. return nil, ErrInvalidAuthToken
  575. }
  576. authInfo, uok := s.AuthStore().AuthInfoFromToken(token)
  577. if !uok {
  578. plog.Warningf("invalid auth token: %s", token)
  579. return nil, ErrInvalidAuthToken
  580. }
  581. return authInfo, nil
  582. }
  583. // doSerialize handles the auth logic, with permissions checked by "chk", for a serialized request "get". Returns a non-nil error on authentication failure.
  584. func (s *EtcdServer) doSerialize(ctx context.Context, chk func(*auth.AuthInfo) error, get func()) error {
  585. for {
  586. ai, err := s.authInfoFromCtx(ctx)
  587. if err != nil {
  588. return err
  589. }
  590. if ai == nil {
  591. // chk expects non-nil AuthInfo; use empty credentials
  592. ai = &auth.AuthInfo{}
  593. }
  594. if err = chk(ai); err != nil {
  595. if err == auth.ErrAuthOldRevision {
  596. continue
  597. }
  598. return err
  599. }
  600. // fetch response for serialized request
  601. get()
  602. // empty credentials or current auth info means no need to retry
  603. if ai.Revision == 0 || ai.Revision == s.authStore.Revision() {
  604. return nil
  605. }
  606. // avoid TOCTOU error, retry of the request is required.
  607. }
  608. }
  609. func (s *EtcdServer) processInternalRaftRequestOnce(ctx context.Context, r pb.InternalRaftRequest) (*applyResult, error) {
  610. ai := s.getAppliedIndex()
  611. ci := s.getCommittedIndex()
  612. if ci > ai+maxGapBetweenApplyAndCommitIndex {
  613. return nil, ErrTooManyRequests
  614. }
  615. r.Header = &pb.RequestHeader{
  616. ID: s.reqIDGen.Next(),
  617. }
  618. authInfo, err := s.authInfoFromCtx(ctx)
  619. if err != nil {
  620. return nil, err
  621. }
  622. if authInfo != nil {
  623. r.Header.Username = authInfo.Username
  624. r.Header.AuthRevision = authInfo.Revision
  625. }
  626. data, err := r.Marshal()
  627. if err != nil {
  628. return nil, err
  629. }
  630. if len(data) > maxRequestBytes {
  631. return nil, ErrRequestTooLarge
  632. }
  633. id := r.ID
  634. if id == 0 {
  635. id = r.Header.ID
  636. }
  637. ch := s.w.Register(id)
  638. cctx, cancel := context.WithTimeout(ctx, s.Cfg.ReqTimeout())
  639. defer cancel()
  640. start := time.Now()
  641. s.r.Propose(cctx, data)
  642. proposalsPending.Inc()
  643. defer proposalsPending.Dec()
  644. select {
  645. case x := <-ch:
  646. return x.(*applyResult), nil
  647. case <-cctx.Done():
  648. proposalsFailed.Inc()
  649. s.w.Trigger(id, nil) // GC wait
  650. return nil, s.parseProposeCtxErr(cctx.Err(), start)
  651. case <-s.done:
  652. return nil, ErrStopped
  653. }
  654. }
  655. func (s *EtcdServer) processInternalRaftRequest(ctx context.Context, r pb.InternalRaftRequest) (*applyResult, error) {
  656. var result *applyResult
  657. var err error
  658. for {
  659. result, err = s.processInternalRaftRequestOnce(ctx, r)
  660. if err != auth.ErrAuthOldRevision {
  661. break
  662. }
  663. }
  664. return result, err
  665. }
  666. // Watchable returns a watchable interface attached to the etcdserver.
  667. func (s *EtcdServer) Watchable() mvcc.WatchableKV { return s.KV() }
  668. func (s *EtcdServer) linearizableReadLoop() {
  669. var rs raft.ReadState
  670. internalTimeout := time.Second
  671. for {
  672. ctx := make([]byte, 8)
  673. binary.BigEndian.PutUint64(ctx, s.reqIDGen.Next())
  674. select {
  675. case <-s.readwaitc:
  676. case <-s.stopping:
  677. return
  678. }
  679. nextnr := newNotifier()
  680. s.readMu.Lock()
  681. nr := s.readNotifier
  682. s.readNotifier = nextnr
  683. s.readMu.Unlock()
  684. cctx, cancel := context.WithTimeout(context.Background(), internalTimeout)
  685. if err := s.r.ReadIndex(cctx, ctx); err != nil {
  686. cancel()
  687. if err == raft.ErrStopped {
  688. return
  689. }
  690. plog.Errorf("failed to get read index from raft: %v", err)
  691. nr.notify(err)
  692. continue
  693. }
  694. cancel()
  695. var (
  696. timeout bool
  697. done bool
  698. )
  699. for !timeout && !done {
  700. select {
  701. case rs = <-s.r.readStateC:
  702. done = bytes.Equal(rs.RequestCtx, ctx)
  703. if !done {
  704. // a previous request might time out. now we should ignore the response of it and
  705. // continue waiting for the response of the current requests.
  706. plog.Warningf("ignored out-of-date read index response (want %v, got %v)", rs.RequestCtx, ctx)
  707. }
  708. case <-time.After(internalTimeout):
  709. plog.Warningf("timed out waiting for read index response")
  710. nr.notify(ErrTimeout)
  711. timeout = true
  712. case <-s.stopping:
  713. return
  714. }
  715. }
  716. if !done {
  717. continue
  718. }
  719. if ai := s.getAppliedIndex(); ai < rs.Index {
  720. select {
  721. case <-s.applyWait.Wait(rs.Index):
  722. case <-s.stopping:
  723. return
  724. }
  725. }
  726. // unblock all l-reads requested at indices before rs.Index
  727. nr.notify(nil)
  728. }
  729. }
  730. func (s *EtcdServer) linearizableReadNotify(ctx context.Context) error {
  731. s.readMu.RLock()
  732. nc := s.readNotifier
  733. s.readMu.RUnlock()
  734. // signal linearizable loop for current notify if it hasn't been already
  735. select {
  736. case s.readwaitc <- struct{}{}:
  737. default:
  738. }
  739. // wait for read state notification
  740. select {
  741. case <-nc.c:
  742. return nc.err
  743. case <-ctx.Done():
  744. return ctx.Err()
  745. case <-s.done:
  746. return ErrStopped
  747. }
  748. }