0.6.0

Breaking changes

We would recommended to consult the suggested 0.6 upgrade path for this release.

• Serf is now a Kong dependency. It allows Kong nodes to communicate between each other opening the way to many features and improvements.
• The configuration file changed. Some properties were renamed, others were moved, and some are new. We would recommended checking out the new default configuration file.
• Drop the Lua 5.1 dependency which was only used by the CLI. The CLI now runs with LuaJIT, which is consistent with other Kong components (Luarocks and OpenResty) already relying on LuaJIT. Make sure the LuaJIT interpreter is included in your $PATH. #799
• kong.pid became nginx.pid

Added

One of the biggest new features of this release is the cluster-awareness added to Kong in #729, which deserves its own section:

• Each Kong node is now aware of belonging to a cluster through Serf. Nodes automatically join the specified cluster according to the configuration file's settings.
• The datastore cache is not invalidated by expiration time anymore, but following an invalidation strategy between the nodes of a same cluster, leading to improved performance.
• Admin API
  • Expose a /cache endpoint for retrieving elements stored in the in-memory cache of a node.
  • Expose a /cluster endpoint used to add/remove/list members of the cluster, and also used internally for data propagation.
• CLI
  • New kong cluster command for cluster management.
  • New kong status command for cluster healthcheck.

Other additions include:

• New Cassandra driver which makes Kong aware of the Cassandra cluster. Kong is now unaffected if one of your Cassandra nodes goes down as long as a replica is available on another node. Load balancing policies also improve the performance along with many other smaller improvements. #803
• Admin API
  • A new total field in API responses, that counts the total number of entities in the datastore. #635
• Configuration
  • Possibility to configure the keyspace replication strategy for Cassandra. It will be taken into account by the migrations when the configured keyspace does not already exist. #350
  • Dnsmasq is now optional. You can specify a custom DNS resolver address that Kong will use when resolving hostnames. This can be configured in kong.yml. #625
• Plugins
  • New "syslog" plugin: send logs to local sytem log. #698
  • New "loggly" plugin: send logs to Loggly over UDP. #698
  • New "datadog" plugin: send logs to Datadog server. #758
  • OAuth2
    • Add support for X-Forwarded-Proto header. #650
    • Expose a new /oauth2_tokens endpoint with the possibility to retrieve, update or delete OAuth 2.0 access tokens. #729
  • JWT:
    • Support for base64 encoded secrets. #838 #577
    • Support to configure the claim in which the key is given into the token (not iss only anymore). #838
  • Request transformer
    • Support for more transformation options: remove, replace, add, append motivated by #393. See #824
    • Support JSON body transformation. #569
  • Response transformer
    • Support for more transformation options: remove, replace, add, append motivated by #393. See #822

Changed

• As mentioned in the breaking changes section, a new configuration file format and validation. All properties are now documented and commented out with their default values. This allows for a lighter configuration file and more clarity as to what properties relate to. It also catches configuration mistakes. #633
• Replace the UUID generator library with a new implementation wrapping lib-uuid, fixing eventual conflicts happening in cases such as described in #659. See #695
• Admin API
  • Increase the maximum body size to 10MB in order to handle configuration requests with heavy payloads. #700
  • Disable access logs for the /status endpoint.
  • The /status endpoint now includes database statistics, while the previous stats have been moved to a server response field. #635

Fixed

• Behaviors described in #603 related to the failure of Cassandra nodes thanks to the new driver. #803
• Latency headers are now properly included in responses sent to the client. #708
• strip_request_path does not add a trailing slash to the API's upstream_url anymore before proxying. #675
• Do not URL decode querystring before proxying the request to the upstream service. #749
• Handle cases when the request would be terminated prior to the Kong execution (that is, before ngx_lua reaches the access_by_lua context) in cases such as the use of a custom nginx module. #594
• Admin API
  • The PUT method now correctly updates boolean fields (such as strip_request_path). #765
  • The PUT method now correctly resets a plugin configuration. #720
  • PATCH correctly set previously unset fields. #861
  • In the responses, the next link is not being displayed anymore if there are no more entities to be returned. #635
  • Prevent the update of created_at fields. #820
  • Better request_path validation for APIs. "/" is not considered a valid path anymore. #881
• Plugins:
  • Galileo: ensure the mimeType value is always a string in ALFs. #584
  • JWT: allow to update JWT credentials using the PATCH method. It previously used to reply with 405 Method not allowed because the PATCH method was not implemented. #667
  • Rate limiting: fix a warning when many periods are configured. #681
  • Basic Authentication: do not re-hash the password field when updating a credential. #726
  • File log: better permissions for on file creation for file-log plugin. #877
  • OAuth2
    • Implement correct responses when the OAuth2 challenges are refused. #737
    • Handle querystring on /authorize and /token URLs. #687
    • Handle punctuation in scopes on /authorize and /token endpoints. #658

_internal_

• Event bus for local and cluster-wide events propagation. Plans for this event bus is to be widely used among Kong in the future.
• The Kong Public Lua API (Lua helpers integrated in Kong such as DAO and Admin API helpers) is now documented with ldoc format and published on the online documentation.
• Work has been done to restore the reliability of the CI platforms.
• Migrations can now execute DML queries (instead of DDL queries only). Handy for migrations implying plugin configuration changes, plugins renamings etc... #770

0.5.4

Fixed

• Mashape Analytics plugin (aka Galileo):
  • Improve stability under heavy load. #757
  • base64 encode ALF request/response bodies, enabling proper support for Galileo bodies inspection capabilities. #747
  • Do not include JSON bodies in ALF postData.params field. #766

0.5.3

Fixed

• Avoids additional URL encoding when proxying to an upstream service. #691
• Fixed potential timing comparison bug in HMAC plugin. #704
• Fixed a missing "env" statement in the Nginx configuration. #706

Added

• The Galileo plugin now supports arbitrary host, port and path values. #721

0.5.2

A few fixes requested by the community!

Fixed

• Kong properly search the nginx in your $PATH variable.
• Plugins:
  • OAuth2: can detect that the originating protocol for a request was HTTPS through the X-Forwarded-Proto header and work behind another reverse proxy (load balancer). #650
  • HMAC signature: support for X-Date header to sign the request for usage in browsers (since the Date header is protected). #641

0.5.1

Fixing a few glitches we let out with 0.5.0!

Added

• Basic Authentication and HMAC Authentication plugins now also send the X-Credential-Username to the upstream server.
• Admin API now accept JSON when receiving a CORS request. #580
• Add a WWW-Authenticate header for HTTP 401 responses for basic-auth and key-auth. #588

Changed

• Protect Kong from POODLE SSL attacks by omitting SSLv3 (CVE-2014-3566). #563
• Remove support for key-auth key in body. #566

Fixed

• Plugins
  • HMAC
    • The migration for this plugin is now correctly being run. #611
    • Wrong username doesn't return HTTP 500 anymore, but 403. #602
  • JWT: iss not being found doesn't return HTTP 500 anymore, but 403. #578
  • OAuth2: client credentials flow does not include a refresh token anymore. #562
• Fix an occasional error when updating a plugin without a config. #571

0.5.0

With new plugins, many improvements and bug fixes, this release comes with breaking changes that will require your attention.

Breaking changes

Several breaking changes are introduced. You will have to slightly change your configuration file and a migration script will take care of updating your database cluster. Please follow the instructions in UPDATE.md for an update without downtime.

• Many plugins were renamed due to new naming conventions for consistency. #480
• In the configuration file, the Cassandra hosts property was renamed to contact_points. #513
• Properties belonging to APIs entities have been renamed for clarity. #513
  • public_dns -> request_host
  • path -> request_path
  • strip_path -> strip_request_path
  • target_url -> upstream_url
• plugins_configurations have been renamed to plugins, and their value property has been renamed to config to avoid confusions. #513
• The database schema has been updated to handle the separation of plugins outside of the core repository.
• The Key authentication and Basic authentication plugins routes have changed:

Old route                             New route
/consumers/:consumer/keyauth       -> /consumers/:consumer/key-auth
/consumers/:consumer/keyauth/:id   -> /consumers/:consumer/key-auth/:id
/consumers/:consumer/basicauth     -> /consumers/:consumer/basic-auth
/consumers/:consumer/basicauth/:id -> /consumers/:consumer/basic-auth/:id

The old routes are still maintained but will be removed in upcoming versions. Consider them deprecated.

• Admin API
  • The route to retrieve enabled plugins is now under /plugins/enabled.
  • The route to retrieve a plugin's configuration schema is now under /plugins/schema/{plugin name}.

Added

• Plugins
  • New Response Rate Limiting plugin: Give a usage quota to your users based on a parameter in your response. #247
  • New ACL (Access Control) plugin: Configure authorizations for your Consumers. #225
  • New JWT (JSON Web Token) plugin: Verify and authenticate JWTs. #519
  • New HMAC signature plugin: Verify and authenticate HMAC signed HTTP requests. #549
  • Plugins migrations. Each plugin can now have its own migration scripts if it needs to store data in your cluster. This is a step forward to improve Kong's pluggable architecture. #443
  • Basic Authentication: the password field is now sha1 encrypted. #33
  • Basic Authentication: now supports credentials in the Proxy-Authorization header. #460

Changed

• Basic Authentication and Key Authentication now require authentication parameters even when the Expect: 100-continue header is being sent. #408
• Key Auth plugin does not support passing the key in the request payload anymore. #566
• APIs' names cannot contain characters from the RFC 3986 reserved list. #589

Fixed

• Resolver
  • Making a request with a querystring will now correctly match an API's path. #496
• Admin API
  • Data associated to a given API/Consumer will correctly be deleted if related Consumer/API is deleted. #107 #438 #504
  • The /api/{api_name_or_id}/plugins/{plugin_name_or_id} changed to /api/{api_name_or_id}/plugins/{plugin_id} to avoid requesting the wrong plugin if two are configured for one API. #482
  • APIs created without a name but with a request_path will now have a name which defaults to the set request_path. #547
• Plugins
  • Mashape Analytics: More robust buffer and better error logging. #471
  • Mashape Analytics: Several ALF (API Log Format) serialization fixes. #515
  • Oauth2: A response is now returned on http://kong:8001/consumers/{consumer}/oauth2/{oauth2_id}. #469
  • Oauth2: Saving authenticated_userid on Password Grant. #476
  • Oauth2: Proper handling of the /oauth2/authorize and /oauth2/token endpoints in the OAuth 2.0 Plugin when an API with a path is being consumed using the public_dns instead. #503
  • OAuth2: Properly returning X-Authenticated-UserId in the client_credentials and password flows. #535
  • Response-Transformer: Properly handling JSON responses that have a charset specified in their Content-Type header.

0.4.2

This update slightly changes the configuration file format, checkout UPDATE.md for instructions.

Added

• Cassandra authentication and SSL encryption. #405
• preserve_host flag on APIs to preserve the Host header when a request is proxied. #444
• Added the Resource Owner Password Credentials Grant to the OAuth 2.0 Plugin. #448
• Auto-generation of default SSL certificate. #453

Changed

• Remove cassandra.port property in configuration. Ports are specified by having cassandra.hosts addresses using the host:port notation (RFC 3986). #457
• Default SSL certificate is now auto-generated and stored in the nginx_working_dir.

Fixed

• Better handling of multi-nodes Cassandra clusters. #450
• mashape-analytics plugin: handling of numerical values in querystrings. #449
• Path resolver strip_path option wrongfully matching the path property multiple times in the request URI. #442
• File Log Plugin bug that prevented the file creation in some environments. #461
• Clean output of the Kong CLI. #235

0.4.1

Fixed

• Issues with the Mashape Analytics plugin. #425
• Handle hyphens when executing path routing with strip_path option enabled. #431
• Adding the Client Credentials OAuth 2.0 flow. #430
• A bug that prevented "dnsmasq" from being started on some systems, including Debian. f7da790
• File Log plugin: optimizations by avoiding the buffered I/O layer. 20bb478

0.4.0

Added

• Implement wildcard subdomains for APIs' public_dns. #381 #297
• Plugins
  • New OAuth 2.0 plugin. #341 #169
  • New Mashape Analyics plugin. #360 #272
  • New IP whitelisting/blacklisting plugin. #379
  • Ratelimiting: support for multiple limits. #382 #205
  • HTTP logging: support for HTTPS endpoint. #342
  • Logging plugins: new properties for logs timing. #351
  • Key authentication: now auto-generates a key if none is specified. #48
• Resolver
  • path property now accepts arbitrary depth. #310
• Admin API
  • Enable CORS by default. #371
  • Expose a new endpoint to get a plugin configuration's schema. #376 #309
  • Expose a new endpoint to retrieve a node's status. 417c137
• CLI
  • $ kong migrations reset now asks for confirmation. #365

Fixed

• Plugins
  • Basic authentication not being executed if added to an API with default configuration. 6d732cd
  • SSL plugin configuration parsing. #353
  • SSL plugin doesn't accept a consumer_id anymore, as this wouldn't make sense. #372 #322
  • Authentication plugins now return 401 when missing credentials. #375 #354
• Admin API
  • Non supported HTTP methods now return 405 instead of 500. 38f1b7f
  • Prevent PATCH requests from overriding a plugin's configuration if partially updated. 9a7388d
• Handle occasionally missing schema_migrations table. #365 #250

internal

• DAO:
  • Complete refactor. No more need for hard-coded queries. #346
• Schemas:
  • New self_check test for schema definitions. 5bfa7ca

0.3.2

Fixed

• Fix for the uppercase Cassandra keyspace bug that prevented Kong to work with kongdb.org