Files
openproject/app/models/token/ical.rb
T
Jan Sandbrink 4d305df714 Allow to use API Tokens as Bearer tokens
We generate those tokens with a prefix, so that we
can decide by looking at a token, whether it's an API Token
or a different kind of token, so that we can decide which
code path to choose for validating the token.

The usage of access tokens as Bearer token has the usability advantage,
that you can paste them as plaintext into tools that expect you
to specify the token as a header.

Also the Basic auth approach for our old tokens usually rather caused
issues, such as browsers prompting for credentials in surprising situations.
If we were to deprecate basic authentication one day, this change today could've
been the first step towards that.
2026-02-05 08:07:04 +01:00

67 lines
2.5 KiB
Ruby

# frozen_string_literal: true
#-- copyright
# OpenProject is an open source project management software.
# Copyright (C) the OpenProject GmbH
#
# This program is free software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License version 3.
#
# OpenProject is a fork of ChiliProject, which is a fork of Redmine. The copyright follows:
# Copyright (C) 2006-2013 Jean-Philippe Lang
# Copyright (C) 2010-2013 the ChiliProject Team
#
# This program is free software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License
# as published by the Free Software Foundation; either version 2
# of the License, or (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
#
# See COPYRIGHT and LICENSE files for more details.
#++
module Token
class ICal < HashedToken
prefix :opical
# restrict the usage of one ical token to one query (calendar)
has_one :ical_token_query_assignment, required: true, dependent: :destroy, foreign_key: :ical_token_id,
class_name: "ICalTokenQueryAssignment", inverse_of: :ical_token
accepts_nested_attributes_for :ical_token_query_assignment
has_one :query, through: :ical_token_query_assignment
has_one :project, through: :query
def token_name
ical_token_query_assignment.name
end
class << self
def create_and_return_value(user, query, token_name)
# using the ! here to raise an exception if the token could
# not be created due to errors in the ical_token_query_assignment
# otherwise a hashed token value of a not persisted token would be returned
create!(user:, ical_token_query_assignment_attributes: {
query:, name: token_name
}).plain_value
end
end
# Prevent deleting previous tokens
# Every time an ical url is generated, a new ical token will be generated for this url as well
# the existing ical tokens (and thus urls) should still be valid
# until the user decides to revert all existing ical tokens (and urls)
def single_value?
false
end
end
end