tanshuku 5.0.0 → 5.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +76 -1
- data/app/controllers/tanshuku/urls_controller.rb +3 -3
- data/app/models/tanshuku/url.rb +11 -4
- data/config/locales/en.yml +2 -0
- data/config/locales/ja.yml +2 -0
- data/lib/tanshuku/configuration.rb +4 -0
- data/lib/tanshuku/version.rb +1 -1
- metadata +2 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: c1070edf493aaa656a9345d5c64959d27045ff7287235a5bb29d5aa1050b683f
|
|
4
|
+
data.tar.gz: f4d8284eea7a68b08c7b02dada4fc0e17808beaecba9a49a1c7c046156dd747a
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 49af2ab27b0e7591fc19a7c782e917b3e21848a9e8393fa47009dbbf501f01908326c76cb5d558f8f244df43ee70104920ea573fb963c6983daeb6561e7c8eef
|
|
7
|
+
data.tar.gz: b24bcfaa56d85865a7fe6687f2fdfc4cc6daab624e6dd947aa85bed598741dcf0ebe11956f2e187120cfffa456929494143d5690d9ce763c09e8e3d1ff13baee
|
data/README.md
CHANGED
|
@@ -135,6 +135,80 @@ Tanshuku::Url.shorten("https://google.com/", namespace: "a") #=> "https://examp
|
|
|
135
135
|
Tanshuku::Url.shorten("https://google.com/", namespace: "a") #=> "https://example.com/t/ab01cd23ef45gh67ij89"
|
|
136
136
|
```
|
|
137
137
|
|
|
138
|
+
#### Security considerations
|
|
139
|
+
|
|
140
|
+
##### Shortening URLs that contain secrets
|
|
141
|
+
|
|
142
|
+
You can shorten URLs that contain secrets such as access tokens, but be aware of the following risks.
|
|
143
|
+
|
|
144
|
+
- Original URLs are stored in the `tanshuku_urls` table as plain text. Anyone who can read the database or its backups can see the secrets.
|
|
145
|
+
- Anyone who knows a shortened URL can access its original URL. Shortened URLs tend to spread through sharing and forwarding.
|
|
146
|
+
- When shortening a URL fails, the default [`config.exception_reporter`](https://kg8m.github.io/tanshuku/Tanshuku/Configuration.html#exception_reporter-instance_method) logs the original URL as is.
|
|
147
|
+
|
|
148
|
+
If you want to keep secrets out of your logs, configure `config.exception_reporter`. The following example filters query parameters of the original URL with your app’s `config.filter_parameters` and removes its fragment before logging it. If the URL can’t be parsed, it removes the query and the fragment instead.
|
|
149
|
+
|
|
150
|
+
```rb
|
|
151
|
+
# config/initializers/tanshuku.rb
|
|
152
|
+
Tanshuku.configure do |config|
|
|
153
|
+
config.exception_reporter =
|
|
154
|
+
lambda { |exception:, original_url:|
|
|
155
|
+
filtered_url =
|
|
156
|
+
begin
|
|
157
|
+
parameter_filter = ActiveSupport::ParameterFilter.new(Rails.application.config.filter_parameters)
|
|
158
|
+
uri = Addressable::URI.parse(original_url)
|
|
159
|
+
|
|
160
|
+
if uri.query
|
|
161
|
+
params = parameter_filter.filter(Rack::Utils.parse_nested_query(uri.query))
|
|
162
|
+
uri.query = Rack::Utils.build_nested_query(params)
|
|
163
|
+
end
|
|
164
|
+
|
|
165
|
+
# Fragments might also contain secrets, e.g., `#access_token=...`.
|
|
166
|
+
uri.fragment = nil
|
|
167
|
+
uri.to_s
|
|
168
|
+
# Shortening a URL often fails because the URL is invalid.
|
|
169
|
+
rescue StandardError
|
|
170
|
+
original_url&.sub(/[?#].*/m, "")
|
|
171
|
+
end
|
|
172
|
+
|
|
173
|
+
# Log only the exception’s class because its message might contain the original URL.
|
|
174
|
+
Rails.logger.warn("Failed to shorten a URL: #{exception.class} for #{filtered_url.inspect}")
|
|
175
|
+
}
|
|
176
|
+
end
|
|
177
|
+
```
|
|
178
|
+
|
|
179
|
+
##### Shortening URLs from user input
|
|
180
|
+
|
|
181
|
+
Tanshuku redirects users to original URLs without checking their hosts, i.e., it redirects to any host. [`config.url_pattern`](https://kg8m.github.io/tanshuku/Tanshuku/Configuration.html#url_pattern-instance_method) only checks the format of URLs and doesn’t ensure that their destinations are safe. For example, both `https://evil.example/` and `//evil.example/` match the default pattern.
|
|
182
|
+
|
|
183
|
+
So if you shorten URLs from user input, check them in your Rails app, e.g., with an allowlist of hosts. Otherwise, the following risks arise.
|
|
184
|
+
|
|
185
|
+
- Attackers can abuse your shortened URLs as open redirects. They can lead users to phishing sites with URLs of your trusted domain.
|
|
186
|
+
- Your domain might be added to blocklists of spam filters or safe browsing services. Then emails containing your legitimate shortened URLs might not be delivered, and browsers might show warnings when users access them.
|
|
187
|
+
|
|
188
|
+
The following example shortens a URL only if it is an absolute path in your app, or if its scheme is HTTP(S) and its host is allowed.
|
|
189
|
+
|
|
190
|
+
```rb
|
|
191
|
+
# Checks whether a URL can be shortened.
|
|
192
|
+
module ShortenableUrl
|
|
193
|
+
ALLOWED_HOSTS = %w[example.com www.example.com].freeze
|
|
194
|
+
|
|
195
|
+
# Returns true if the URL is an absolute path or an HTTP(S) URL with an allowed host.
|
|
196
|
+
def self.allowed?(url)
|
|
197
|
+
uri = Addressable::URI.parse(url)
|
|
198
|
+
|
|
199
|
+
if uri.host
|
|
200
|
+
%w[http https].include?(uri.normalized_scheme) && ALLOWED_HOSTS.include?(uri.normalized_host)
|
|
201
|
+
else
|
|
202
|
+
uri.scheme.nil? && uri.path.start_with?("/")
|
|
203
|
+
end
|
|
204
|
+
rescue Addressable::URI::InvalidURIError
|
|
205
|
+
false
|
|
206
|
+
end
|
|
207
|
+
end
|
|
208
|
+
|
|
209
|
+
Tanshuku::Url.shorten(user_input) if ShortenableUrl.allowed?(user_input)
|
|
210
|
+
```
|
|
211
|
+
|
|
138
212
|
#### More information
|
|
139
213
|
|
|
140
214
|
cf. [`Tanshuku::Url.shorten`’s API documentation](https://kg8m.github.io/tanshuku/Tanshuku/Url.html#shorten-class_method)
|
|
@@ -197,4 +271,5 @@ A. Does Tanshuku have some missing features? Please [create an issue](https://gi
|
|
|
197
271
|
1. Make your repository fresh
|
|
198
272
|
1. `bump current` and confirm the current version
|
|
199
273
|
1. `bump patch`, `bump minor`, or `bump major`
|
|
200
|
-
1. `rake release`
|
|
274
|
+
1. `gem_push=no rake release` to create a tag and push it with the branch
|
|
275
|
+
1. Approve the triggered [“Create a Release” workflow](.github/workflows/create-release.yml), which pushes the gem to RubyGems.org and creates a GitHub Release
|
|
@@ -1,13 +1,13 @@
|
|
|
1
1
|
# frozen_string_literal: true
|
|
2
2
|
|
|
3
3
|
module Tanshuku
|
|
4
|
-
# A Rails controller class for finding a {Tanshuku::Url} record and redirecting to its
|
|
4
|
+
# A Rails controller class for finding a {Tanshuku::Url} record and redirecting to its original URL.
|
|
5
5
|
class UrlsController < ActionController::API
|
|
6
|
-
# Finds a {Tanshuku::Url} record from the given +key+ parameter and redirects to its
|
|
6
|
+
# Finds a {Tanshuku::Url} record from the given +key+ parameter and redirects to its original URL.
|
|
7
7
|
#
|
|
8
8
|
# @return [void]
|
|
9
9
|
#
|
|
10
|
-
# @raise [ActiveRecord::
|
|
10
|
+
# @raise [ActiveRecord::RecordNotFound] If no {Tanshuku::Url} record is found for the given +key+.
|
|
11
11
|
def show
|
|
12
12
|
url = Url.find_by!(key: params.expect(:key))
|
|
13
13
|
redirect_to url.url, status: :moved_permanently, allow_other_host: true
|
data/app/models/tanshuku/url.rb
CHANGED
|
@@ -7,7 +7,7 @@ require "rack"
|
|
|
7
7
|
module Tanshuku
|
|
8
8
|
# rubocop:disable Rails/ApplicationRecord
|
|
9
9
|
#
|
|
10
|
-
# An +ActiveRecord::Base+ inherited class for a shortened URL. This class also
|
|
10
|
+
# An +ActiveRecord::Base+ inherited class for a shortened URL. This class also has some logic for shortening URLs.
|
|
11
11
|
class Url < ActiveRecord::Base
|
|
12
12
|
# @!attribute [rw] url
|
|
13
13
|
# @return [String] Original, i.e., non-shortened, URL of the record.
|
|
@@ -29,6 +29,10 @@ module Tanshuku
|
|
|
29
29
|
validates :url, length: { maximum: proc { Tanshuku.config.max_url_length } }
|
|
30
30
|
validates :url, format: { with: proc { Tanshuku.config.url_pattern } }, allow_blank: true
|
|
31
31
|
|
|
32
|
+
# Don’t allow dots in keys because a dot in a path is treated as a separator of the format by the routing, e.g.,
|
|
33
|
+
# `/t/abc.json` is routed to the key `abc` with the format `json`.
|
|
34
|
+
validates :key, format: { without: /\./ }, allow_blank: true
|
|
35
|
+
|
|
32
36
|
# Don’t validate uniqueness of unique attributes. Raise ActiveRecord::RecordNotUnique instead if the attributes get
|
|
33
37
|
# duplicated. Then rescue the exception and try to retry.
|
|
34
38
|
# validates :url, :hashed_url, :key, uniqueness: true
|
|
@@ -44,7 +48,7 @@ module Tanshuku
|
|
|
44
48
|
# +shorten("https://google.com")+ have the same result.
|
|
45
49
|
#
|
|
46
50
|
# @param original_url [String] The original, i.e., non-shortened, URL.
|
|
47
|
-
# @param namespace [String] A namespace for
|
|
51
|
+
# @param namespace [String] A namespace for shortening the URL. Shortened URLs are unique in namespaces.
|
|
48
52
|
# @param url_options [Hash] An option for Rails’ +url_for+.
|
|
49
53
|
#
|
|
50
54
|
# @return [String] A shortened URL if succeeded to shorten the original URL.
|
|
@@ -81,14 +85,17 @@ module Tanshuku
|
|
|
81
85
|
|
|
82
86
|
begin
|
|
83
87
|
transaction do
|
|
88
|
+
# Find an existing record first because the URL is often already shortened. Otherwise, try to create a new
|
|
89
|
+
# record. It also handles the race condition of creating records for the same URL.
|
|
84
90
|
record =
|
|
85
|
-
|
|
91
|
+
find_or_create_by!(hashed_url: hash_url(url, namespace:)) do |r|
|
|
86
92
|
r.attributes = { url:, key: generate_key }
|
|
87
93
|
end
|
|
88
94
|
|
|
89
95
|
record.shortened_url(url_options)
|
|
90
96
|
end
|
|
91
|
-
# ActiveRecord::RecordNotFound is raised when the key is duplicated
|
|
97
|
+
# ActiveRecord::RecordNotFound is raised when the key is duplicated: creating a record raises
|
|
98
|
+
# ActiveRecord::RecordNotUnique, and then no record is found for the hashed URL.
|
|
92
99
|
rescue ActiveRecord::RecordNotFound => e
|
|
93
100
|
if retries < 10
|
|
94
101
|
retries += 1
|
data/config/locales/en.yml
CHANGED
data/config/locales/ja.yml
CHANGED
|
@@ -140,6 +140,10 @@ module Tanshuku
|
|
|
140
140
|
# A class, module, or object that responds to +#call+ without any arguments.
|
|
141
141
|
# @return [void] If you set an invalid object.
|
|
142
142
|
#
|
|
143
|
+
# @note
|
|
144
|
+
# Generated keys should not contain dots (+.+) because a dot in a path is treated as a separator of the format,
|
|
145
|
+
# e.g., +/t/abc.json+ is routed to the key +abc+. Shortening a URL fails if a generated key contains dots.
|
|
146
|
+
#
|
|
143
147
|
# @note The example below means that unique keys for shortened URLs are generated by +SecureRandom.uuid+.
|
|
144
148
|
#
|
|
145
149
|
# @example
|
data/lib/tanshuku/version.rb
CHANGED
metadata
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: tanshuku
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 5.0.
|
|
4
|
+
version: 5.0.1
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- kg8m
|
|
@@ -91,7 +91,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
|
91
91
|
- !ruby/object:Gem::Version
|
|
92
92
|
version: '0'
|
|
93
93
|
requirements: []
|
|
94
|
-
rubygems_version: 4.0.
|
|
94
|
+
rubygems_version: 4.0.20
|
|
95
95
|
specification_version: 4
|
|
96
96
|
summary: Tanshuku is a simple and performance aware Rails engine for shortening URLs.
|
|
97
97
|
test_files: []
|