GeezerVisonThe World Wide Web, restored to 800 pixels of glory. |
| Home|About|Gaming cabinet|Archives|How it works|Starter sites |
GeezerVison is showing github.com — kite/kite.go at master · koding/kite Expand file tree/ Copy pathkite.goMore file actions 548 lines (445 loc) · 14.2 KB / Copy pathkite.goFile metadata and controls548 lines (445 loc) · 14.2 KB 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 // Package kite is a library for creating micro-services. Two main types // implemented by this package are Kite for creating a micro-service server // called "Kite" and Client for communicating with another kites. package kite import ( "bytes" "crypto/rsa" "crypto/tls" "errors" "fmt" "io" "net/http" "net/url" "os" "strings" "sync" "time" "github.com/koding/kite/config" "github.com/koding/kite/kitekey" "github.com/koding/kite/protocol" jwt "github.com/dgrijalva/jwt-go" "github.com/gorilla/mux" "github.com/igm/sockjs-go/sockjs" "github.com/koding/cache" "github.com/koding/kite/sockjsclient" uuid "github.com/satori/go.uuid" ) var hostname string func init() { var err error hostname, err = os.Hostname() if err != nil { panic(fmt.Sprintf("kite: cannot get hostname: %s", err.Error())) } jwt.TimeFunc = func() time.Time { return time.Now().UTC() } } // Kite defines a single process that enables distributed service messaging // amongst the peers it is connected. A Kite process acts as a Client and as a // Server. That means it can receive request, process them, but it also can // make request to other kites. // // Do not use this struct directly. Use kite.New function, add your handlers // with HandleFunc mehtod, then call Run method to start the inbuilt server (or // pass it to any http.Handler compatible server) type Kite struct { Config *config.Config // Log logs with the given Logger interface Log Logger // SetLogLevel changes the level of the logger. Default is INFO. SetLogLevel func(Level) // Contains different functions for authenticating user from request. // Keys are the authentication types (options.auth.type). Authenticators map[string]func(*Request) error // ClientFunc is used as the default value for kite.Client.ClientFunc. // If nil, a default ClientFunc will be used. // // Deprecated: Set Config.XHR field instead. ClientFunc func(*sockjsclient.DialOptions) *http.Client // WebRTCHandler handles the webrtc responses coming from a signalling server. WebRTCHandler Handler // Handlers added with Kite.HandleFunc(). handlers map[string]*Method // method map for exported methods preHandlers []Handler // a list of handlers that are executed before any handler postHandlers []Handler // a list of handlers that are executed after any handler finalFuncs []FinalFunc // a list of funcs executed after any handler regardless of the error // MethodHandling defines how the kite is returning the response for // multiple handlers MethodHandling MethodHandling // HTTP muxer muxer *mux.Router // kontrolclient is used to register to kontrol and query third party kites // from kontrol kontrol *kontrolClient // kontrolKey stores parsed Config.KontrolKey kontrolKey *rsa.PublicKey // configMu protects access to Config.{Kite,Kontrol}Key fields. configMu sync.RWMutex // verifyCache is used as a cache for verify method. // // The field is set by verifyInit method. verifyCache *cache.MemoryTTL // verifyFunc is a verify method used to verify auth keys. // // For more details see (config.Config).VerifyFunc. // // The field is set by verifyInit method. verifyFunc func(pub string) error // verifyAudienceFunc is used to verify the audience of an // an incoming JWT token. // // For more details see (config.Config).VerifyAudienceFunc. // // The field is set by verifyInit method. verifyAudienceFunc func(*protocol.Kite, string) error // verifyOnce ensures all verify* fields are set up only once. verifyOnce sync.Once // mu protects assigment to verifyCache mu sync.Mutex // Handlers to call when a new connection is received. onConnectHandlers []func(*Client) // Handlers to call before the first request of connected kite. onFirstRequestHandlers []func(*Client) // Handlers to call when a client has disconnected. onDisconnectHandlers []func(*Client) // onRegisterHandlers field holds callbacks invoked when Kite // registers successfully to Kontrol onRegisterHandlers []func(*protocol.RegisterResult) // handlersMu protects access to on*Handlers fields. handlersMu sync.RWMutex // heartbeatC is used to control kite's heartbeats; sending // a non-nil value on the channel makes heartbeat goroutine issue // new heartbeats; sending nil value stops heartbeats heartbeatC chan *heartbeatReq // server fields, are initialized and used when // TODO: move them to their own struct, just like KontrolClient listener *gracefulListener TLSConfig *tls.Config readyC chan bool // To signal when kite is ready to accept connections closeC chan bool // To signal when kite is closed with Close() name string version string Id string // Unique kite instance id } // New creates, initializes and then returns a new Kite instance. // // Version must be in 3-digit semantic form. // // Name is important that it's also used to be searched by others. func New(name, version string) *Kite { return NewWithConfig(name, version, config.New()) } // NewWithConfig builds a new kite value for the given configuration. func NewWithConfig(name, version string, cfg *config.Config) *Kite { if name == "" { panic("kite: name cannot be empty") } if digits := strings.Split(version, "."); len(digits) != 3 { panic("kite: version must be 3-digits semantic version") } kiteID := uuid.Must(uuid.NewV4()) l, setlevel := newLogger(name) kClient := &kontrolClient{ readyConnected: make(chan struct{}), readyRegistered: make(chan struct{}), registerChan: make(chan *url.URL, 1), } k := &Kite{ Config: cfg, Log: l, SetLogLevel: setlevel, Authenticators: make(map[string]func(*Request) error), handlers: make(map[string]*Method), kontrol: kClient, name: name, version: version, Id: kiteID.String(), readyC: make(chan bool), closeC: make(chan bool), heartbeatC: make(chan *heartbeatReq, 1), muxer: mux.NewRouter(), } if cfg != nil && cfg.UseWebRTC { k.WebRTCHandler = NewWebRCTHandler() } // All sockjs communication is done through this endpoint.. k.muxer.PathPrefix("/kite").Handler(sockjs.NewHandler("/kite", *cfg.SockJS, k.sockjsHandler)) // Add useful debug logs k.OnConnect(func(c *Client) { k.Log.Debug("New session: %s", c.session.ID()) }) k.OnFirstRequest(func(c *Client) { k.Log.Debug("Session %q is identified as %q", c.session.ID(), c.Kite) }) k.OnDisconnect(func(c *Client) { k.Log.Debug("Kite has disconnected: %q", c.Kite) }) k.OnRegister(k.updateAuth) // Every kite should be able to authenticate the user from token. // Tokens are granted by Kontrol Kite. k.Authenticators["token"] = k.AuthenticateFromToken // A kite accepts requests with the same username. k.Authenticators["kiteKey"] = k.AuthenticateFromKiteKey // Register default methods and handlers. k.addDefaultHandlers() go k.processHeartbeats() return k } // Kite returns the definition of the kite. func (k *Kite) Kite() *protocol.Kite { return &protocol.Kite{ Username: k.Config.Username, Environment: k.Config.Environment, Name: k.name, Version: k.version, Region: k.Config.Region, Hostname: hostname, ID: k.Id, } } // KiteKey gives a kite key used to authenticate to kontrol and other kites. func (k *Kite) KiteKey() string { k.configMu.RLock() defer k.configMu.RUnlock() return k.Config.KiteKey } // KontrolKey gives a Kontrol's public key. // // The value is taken form kite key's kontrolKey claim. func (k *Kite) KontrolKey() *rsa.PublicKey { k.configMu.RLock() defer k.configMu.RUnlock() return k.kontrolKey } // HandleHTTP registers the HTTP handler for the given pattern into the // underlying HTTP muxer. func (k *Kite) HandleHTTP(pattern string, handler http.Handler) { k.muxer.Handle(pattern, handler) } // HandleHTTPFunc registers the HTTP handler for the given pattern into the // underlying HTTP muxer. func (k *Kite) HandleHTTPFunc(pattern string, handler func(http.ResponseWriter, *http.Request)) { k.muxer.HandleFunc(pattern, handler) } // ServeHTTP helps Kite to satisfy the http.Handler interface. So kite can be // used as a standard http server. func (k *Kite) ServeHTTP(w http.ResponseWriter, req *http.Request) { k.muxer.ServeHTTP(w, req) } func (k *Kite) sockjsHandler(session sockjs.Session) { defer session.Close(3000, "Go away!") // This Client also handles the connected client. // Since both sides can send/receive messages the client code is reused here. c := k.NewClient("") defer c.Close() c.setSession(session) c.wg.Add(1) go c.sendHub() k.callOnConnectHandlers(c) c.callOnConnectHandlers() // Run after methods are registered and delegate is set c.readLoop() c.callOnDisconnectHandlers() k.callOnDisconnectHandlers(c) } // OnConnect registers a callbacks which is called when a Kite connects // to the k Kite. func (k *Kite) OnConnect(handler func(*Client)) { k.handlersMu.Lock() k.onConnectHandlers = append(k.onConnectHandlers, handler) k.handlersMu.Unlock() } // OnFirstRequest registers a function to run when we receive first request // from other Kite. func (k *Kite) OnFirstRequest(handler func(*Client)) { k.handlersMu.Lock() k.onFirstRequestHandlers = append(k.onFirstRequestHandlers, handler) k.handlersMu.Unlock() } // OnDisconnect registers a function to run when a connected Kite is disconnected. func (k *Kite) OnDisconnect(handler func(*Client)) { k.handlersMu.Lock() k.onDisconnectHandlers = append(k.onDisconnectHandlers, handler) k.handlersMu.Unlock() } // OnRegister registers a callback which is called when a Kite registers // to a Kontrol. func (k *Kite) OnRegister(handler func(*protocol.RegisterResult)) { k.handlersMu.Lock() k.onRegisterHandlers = append(k.onRegisterHandlers, handler) k.handlersMu.Unlock() } func (k *Kite) callOnConnectHandlers(c *Client) { k.handlersMu.RLock() defer k.handlersMu.RUnlock() for _, handler := range k.onConnectHandlers { func() { defer nopRecover() handler(c) }() } } func (k *Kite) callOnFirstRequestHandlers(c *Client) { k.handlersMu.RLock() defer k.handlersMu.RUnlock() for _, handler := range k.onFirstRequestHandlers { func() { defer nopRecover() handler(c) }() } } func (k *Kite) callOnDisconnectHandlers(c *Client) { k.handlersMu.RLock() defer k.handlersMu.RUnlock() for _, handler := range k.onDisconnectHandlers { func() { defer nopRecover() handler(c) }() } } func (k *Kite) callOnRegisterHandlers(r *protocol.RegisterResult) { k.handlersMu.RLock() defer k.handlersMu.RUnlock() for _, handler := range k.onRegisterHandlers { func() { defer nopRecover() handler(r) }() } } func (k *Kite) updateAuth(reg *protocol.RegisterResult) { k.configMu.Lock() defer k.configMu.Unlock() switch { case reg.KiteKey != "": k.Config.KiteKey = reg.KiteKey ex := &kitekey.Extractor{ Claims: &kitekey.KiteClaims{}, } if _, err := jwt.ParseWithClaims(reg.KiteKey, ex.Claims, ex.Extract); err != nil { k.Log.Error("auth update: unable to extract kontrol key: %s", err) break } if ex.Claims.KontrolKey != "" { reg.PublicKey = ex.Claims.KontrolKey } } // we also received a new public key (means the old one was invalidated). // Use it now. if reg.PublicKey != "" { k.Config.KontrolKey = reg.PublicKey key, err := jwt.ParseRSAPublicKeyFromPEM([]byte(reg.PublicKey)) if err != nil { k.Log.Error("auth update: unable to update kontrol key: %s", err) return } k.kontrolKey = key } } // RSAKey returns the corresponding public key for the issuer of the token. // It is called by jwt-go package when validating the signature in the token. func (k *Kite) RSAKey(token *jwt.Token) (interface{}, error) { k.verifyOnce.Do(k.verifyInit) kontrolKey := k.KontrolKey() if kontrolKey == nil { panic("kontrol key is not set in config") } if _, ok := token.Method.(*jwt.SigningMethodRSA); !ok { return nil, errors.New("invalid signing method") } claims, ok := token.Claims.(*kitekey.KiteClaims) if !ok { return nil, errors.New("token does not have valid claims") } if claims.Issuer != k.Config.KontrolUser { return nil, fmt.Errorf("issuer is not trusted: %s", claims.Issuer) } return kontrolKey, nil } // ErrClose is returned by the Close function, when the argument passed // to it was a slice of kites. type ErrClose struct { // Errs has always length of the slice passed to the Close function. // It contains at least one non-nil error. Errs []error } // Error implements the built-in error interface. func (err *ErrClose) Error() string { if len(err.Errs) == 1 { return err.Errs[0].Error() } var buf bytes.Buffer fmt.Fprintf(&buf, "The following kites failed to close:\n\n") for i, e := range err.Errs { if e == nil { continue } fmt.Fprintf(&buf, "\t[%d] %s\n", i, e) } return buf.String() } // Closer returns a io.Closer that can be used to close all the kites // given by the generic argument. // // The kites is expected to be one of: // // - *kite.Kite // - []*kite.Kite // - *kite.Client // - []*kite.Client // // If the kites argument is a slice and at least one of the kites returns // error on Close, the Close method returns *ErrClose. // // TODO(rjeczalik): Currently (*Kite).Close and (*Client).Close does // not implement io.Closer interface - when [0] is resolved, this // method should be adopted accordingly. // // [0] - https://github.com/koding/kite/issues/183 // func Closer(kites interface{}) io.Closer { switch k := kites.(type) { case *Kite: return closerFunc(func() []error { k.Close() return nil }) case []*Kite: return closerFunc(func() []error { for _, k := range k { k.Close() } return nil }) case *Client: return closerFunc(func() []error { k.Close() return nil }) case []*Client: return closerFunc(func() []error { for _, c := range k { c.Close() } return nil }) default: panic(fmt.Errorf("unrecognized type passed to Close %T", kites)) } } // Close is a wrapper for Closer that calls a Close on it. func Close(kites interface{}) error { return Closer(kites).Close() } type closerFunc func() []error func (fn closerFunc) Close() error { errs := fn() if len(errs) > 1 { return &ErrClose{ Errs: errs, } } if len(errs) == 1 && errs[0] != nil { return errs[0] } return nil } func nopRecover() { recover() } |
| You are visitor 01402520 — GeezerVison does not store the pages you look up. Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required. |