zydronium/internetee-registry
1
0
Fork 0
mirror of https://github.com/internetee/registry.git synced 2025-06-04 11:47:30 +02:00
Code Issues Projects Releases Packages Wiki Activity

Use errors as first-class objects

Browse source
This commit is contained in:
Alex Sherman 2021-05-04 13:44:11 +05:00
parent 72c865e656
commit d4775ba5c5
8 changed files with 146 additions and 186 deletions
Download patch file Download diff file Expand all files Collapse all files

118
app/controllers/epp/base_controller.rb
View file

@ -28,27 +28,24 @@ module Epp
protected protected
def respond_with_command_failed_error(exception) def respond_with_command_failed_error(exception)
epp_errors << { epp_errors.add(:epp_errors,
code: '2400', code: '2400',
msg: 'Command failed', message: 'Command failed')
}
handle_errors handle_errors
log_exception(exception) log_exception(exception)
end end
def respond_with_object_does_not_exist_error def respond_with_object_does_not_exist_error
epp_errors << { epp_errors.add(:epp_errors,
code: '2303', code: '2303',
msg: 'Object does not exist', msg: 'Object does not exist')
}
handle_errors handle_errors
end end
def respond_with_authorization_error def respond_with_authorization_error
epp_errors << { epp_errors.add(:epp_errors,
code: '2201', code: '2201',
msg: 'Authorization error', msg: 'Authorization error')
}
handle_errors handle_errors
end end
@ -63,10 +60,9 @@ module Epp
def validate_against_schema def validate_against_schema
return if %w[hello error].include?(params[:action]) return if %w[hello error].include?(params[:action])
schema.validate(params[:nokogiri_frame]).each do |error| schema.validate(params[:nokogiri_frame]).each do |error|
epp_errors << { epp_errors.add(:epp_errors,
code: 2001, code: 2001,
msg: error msg: error)
}
end end
handle_errors and return if epp_errors.any? handle_errors and return if epp_errors.any?
end end
@ -94,7 +90,7 @@ module Epp
# ERROR + RESPONSE HANDLING # ERROR + RESPONSE HANDLING
def epp_errors def epp_errors
@errors ||= [] @errors ||= ActiveModel::Errors.new(self)
end end
def handle_errors(obj = nil) def handle_errors(obj = nil)
@ -102,21 +98,9 @@ module Epp
if obj if obj
obj.construct_epp_errors obj.construct_epp_errors
@errors += obj.errors.where[:epp_errors].flatten obj.errors.each { |error| @errors.import error }
end end
if params[:parsed_frame]&.at_css('update')
@errors.each_with_index do |errors, index|
if errors[:code] == '2304' &&
errors[:value].present? &&
errors[:value][:val] == DomainStatus::SERVER_DELETE_PROHIBITED &&
errors[:value][:obj] == 'status'
@errors[index][:value][:val] = DomainStatus::PENDING_UPDATE
end
end
end
@errors.uniq!
render_epp_response '/epp/error' render_epp_response '/epp/error'
end end
@ -133,10 +117,9 @@ module Epp
return true return true
end end
epp_errors << { epp_errors.add(:epp_errors,
msg: 'Parameter value policy error. Allowed only Latin characters.', msg: 'Parameter value policy error. Allowed only Latin characters.',
code: '2306' code: '2306')
}
handle_errors and return false handle_errors and return false
end end
@ -180,10 +163,9 @@ module Epp
else else
missing = el.present? ? el.text.blank? : true missing = el.present? ? el.text.blank? : true
end end
epp_errors << { epp_errors.add(:epp_errors,
code: '2003', code: '2003',
msg: I18n.t('errors.messages.required_parameter_missing', key: "#{full_selector} [#{attr}]") message: I18n.t('errors.messages.required_parameter_missing', key: "#{full_selector} [#{attr}]")) if missing
} if missing
end end
missing ? false : el # return last selector if it was present missing ? false : el # return last selector if it was present
@ -201,25 +183,22 @@ module Epp
attribute = element[attribute_selector] attribute = element[attribute_selector]
unless attribute unless attribute
epp_errors << { epp_errors.add(:epp_errors,
code: '2003', code: '2003',
msg: I18n.t('errors.messages.required_parameter_missing', key: attribute_selector) msg: I18n.t('errors.messages.required_parameter_missing', key: attribute_selector))
}
return return
end end
return if options[:values].include?(attribute) return if options[:values].include?(attribute)
if options[:policy] if options[:policy]
epp_errors << { epp_errors.add(:epp_errors,
code: '2306', code: '2306',
msg: I18n.t('attribute_is_invalid', attribute: attribute_selector) msg: I18n.t('attribute_is_invalid', attribute: attribute_selector))
}
else else
epp_errors << { epp_errors.add(:epp_errors,
code: '2004', code: '2004',
msg: I18n.t('parameter_value_range_error', key: attribute_selector) msg: I18n.t('parameter_value_range_error', key: attribute_selector))
}
end end
end end
@ -231,30 +210,27 @@ module Epp
attribute = element[attribute_selector] attribute = element[attribute_selector]
return if (attribute && options[:values].include?(attribute)) || !attribute return if (attribute && options[:values].include?(attribute)) || !attribute
epp_errors << { epp_errors.add(:epp_errors,
code: '2306', code: '2306',
msg: I18n.t('attribute_is_invalid', attribute: attribute_selector) msg: I18n.t('attribute_is_invalid', attribute: attribute_selector))
}
end end
def exactly_one_of(*selectors) def exactly_one_of(*selectors)
full_selectors = create_full_selectors(*selectors) full_selectors = create_full_selectors(*selectors)
return if element_count(*full_selectors, use_prefix: false) == 1 return if element_count(*full_selectors, use_prefix: false) == 1
epp_errors << { epp_errors.add(:epp_errors,
code: '2306', code: '2306',
msg: I18n.t(:exactly_one_parameter_required, params: full_selectors.join(' OR ')) msg: I18n.t(:exactly_one_parameter_required, params: full_selectors.join(' OR ')))
}
end end
def mutually_exclusive(*selectors) def mutually_exclusive(*selectors)
full_selectors = create_full_selectors(*selectors) full_selectors = create_full_selectors(*selectors)
return if element_count(*full_selectors, use_prefix: false) <= 1 return if element_count(*full_selectors, use_prefix: false) <= 1
epp_errors << { epp_errors.add(:epp_errors,
code: '2306', code: '2306',
msg: I18n.t(:mutally_exclusive_params, params: full_selectors.join(', ')) msg: I18n.t(:mutally_exclusive_params, params: full_selectors.join(', ')))
}
end end
def optional(selector, *validations) def optional(selector, *validations)
@ -265,8 +241,8 @@ module Epp
validations.each do |x| validations.each do |x|
validator = "#{x.first[0]}_validator".camelize.constantize validator = "#{x.first[0]}_validator".camelize.constantize
err = validator.validate_epp(selector.split(' ').last, value) result = validator.validate_epp(selector.split(' ').last, value)
epp_errors << err if err epp_errors.add(:epp_errors, result) if result
end end
end end
@ -297,10 +273,9 @@ module Epp
def xml_attrs_present?(ph, attributes) # TODO: THIS IS DEPRECATED AND WILL BE REMOVED IN FUTURE def xml_attrs_present?(ph, attributes) # TODO: THIS IS DEPRECATED AND WILL BE REMOVED IN FUTURE
attributes.each do |x| attributes.each do |x|
epp_errors << { epp_errors.add(:epp_errors,
code: '2003', code: '2003',
msg: I18n.t('errors.messages.required_parameter_missing', key: x.last) msg: I18n.t('errors.messages.required_parameter_missing', key: x.last)) unless has_attribute(ph, x)
} unless has_attribute(ph, x)
end end
epp_errors.empty? epp_errors.empty?
end end
@ -355,10 +330,9 @@ module Epp
def enforce_epp_session_timeout def enforce_epp_session_timeout
if epp_session.timed_out? if epp_session.timed_out?
epp_errors << { epp_errors.add(:epp_errors,
code: '2201', code: '2201',
msg: 'Authorization error: Session timeout', msg: 'Authorization error: Session timeout')
}
handle_errors handle_errors
epp_session.destroy! epp_session.destroy!
else else

50
app/controllers/epp/contacts_controller.rb
View file

@ -72,9 +72,10 @@ module Epp
end end
def action_call_response(action:) def action_call_response(action:)
# rubocop:disable Style/AndOr unless action.call
(handle_errors(@contact) and return) unless action.call handle_errors(@contact)
# rubocop:enable Style/AndOr return
end
if opt_addr? if opt_addr?
@response_code = 1100 @response_code = 1100
@ -134,24 +135,16 @@ module Epp
ident = params[:parsed_frame].css('ident') ident = params[:parsed_frame].css('ident')
if ident.present? && ident.attr('type').blank? if ident.present? && ident.attr('type').blank?
epp_errors << { epp_errors.add(:epp_errors,
code: '2003', code: '2003',
msg: I18n.t('errors.messages.required_ident_attribute_missing', key: 'type') msg: I18n.t('errors.messages.required_ident_attribute_missing', key: 'type'))
}
end end
if ident.present? && ident.text != 'birthday' && ident.attr('cc').blank? if ident.present? && ident.text != 'birthday' && ident.attr('cc').blank?
epp_errors << { epp_errors.add(:epp_errors,
code: '2003', code: '2003',
msg: I18n.t('errors.messages.required_ident_attribute_missing', key: 'cc') msg: I18n.t('errors.messages.required_ident_attribute_missing', key: 'cc'))
}
end end
# if ident.present? && ident.attr('cc').blank?
# epp_errors << {
# code: '2003',
# msg: I18n.t('errors.messages.required_ident_attribute_missing', key: 'cc')
# }
# end
contact_org_disabled contact_org_disabled
fax_disabled fax_disabled
status_editing_disabled status_editing_disabled
@ -178,28 +171,27 @@ module Epp
return true if ENV['contact_org_enabled'] == 'true' return true if ENV['contact_org_enabled'] == 'true'
return true if params[:parsed_frame].css('postalInfo org').text.blank? return true if params[:parsed_frame].css('postalInfo org').text.blank?
epp_errors << { epp_errors.add(:epp_errors,
code: '2306', code: '2306',
msg: "#{I18n.t(:contact_org_error)}: postalInfo > org [org]" msg: "#{I18n.t(:contact_org_error)}: postalInfo > org [org]"
} )
end end
def fax_disabled def fax_disabled
return true if ENV['fax_enabled'] == 'true' return true if ENV['fax_enabled'] == 'true'
return true if params[:parsed_frame].css('fax').text.blank? return true if params[:parsed_frame].css('fax').text.blank?
epp_errors << { epp_errors.add(:epp_errors,
code: '2306', code: '2306',
msg: "#{I18n.t(:contact_fax_error)}: fax [fax]" msg: "#{I18n.t(:contact_fax_error)}: fax [fax]")
}
end end
def status_editing_disabled def status_editing_disabled
return true if Setting.client_status_editing_enabled return true if Setting.client_status_editing_enabled
return true if params[:parsed_frame].css('status').empty? return true if params[:parsed_frame].css('status').empty?
epp_errors << { epp_errors.add(:epp_errors,
code: '2306', code: '2306',
msg: "#{I18n.t(:client_side_status_editing_error)}: status [status]" msg: "#{I18n.t(:client_side_status_editing_error)}: status [status]"
} )
end end
def address_given? def address_given?

52
app/controllers/epp/domains_controller.rb
View file

@ -90,10 +90,9 @@ module Epp
action = params[:parsed_frame].css('transfer').first[:op] action = params[:parsed_frame].css('transfer').first[:op]
if @domain.non_transferable? if @domain.non_transferable?
epp_errors << { epp_errors.add(:epp_errors,
code: '2304', code: '2304',
msg: I18n.t(:object_status_prohibits_operation), msg: I18n.t(:object_status_prohibits_operation))
}
handle_errors handle_errors
return return
end end
@ -102,10 +101,9 @@ module Epp
wrong_transfer_code = provided_transfer_code != @domain.transfer_code wrong_transfer_code = provided_transfer_code != @domain.transfer_code
if wrong_transfer_code if wrong_transfer_code
epp_errors << { epp_errors.add(:epp_errors,
code: '2202', code: '2202',
msg: 'Invalid authorization information', msg: 'Invalid authorization information')
}
handle_errors handle_errors
return return
end end
@ -120,10 +118,9 @@ module Epp
if @domain_transfer if @domain_transfer
render_epp_response '/epp/domains/transfer' render_epp_response '/epp/domains/transfer'
else else
epp_errors << { epp_errors.add(:epp_errors,
code: '2303', code: '2303',
msg: I18n.t('no_transfers_found') msg: I18n.t('no_transfers_found'))
}
handle_errors handle_errors
end end
end end
@ -184,11 +181,10 @@ module Epp
def validate_transfer def validate_transfer
# period element is disabled for now # period element is disabled for now
if params[:parsed_frame].css('period').any? if params[:parsed_frame].css('period').any?
epp_errors << { epp_errors.add(:epp_errors,
code: '2307', code: '2307',
msg: I18n.t(:unimplemented_object_service), msg: I18n.t(:unimplemented_object_service),
value: { obj: 'period' } value: { obj: 'period' })
}
end end
requires 'transfer > transfer' requires 'transfer > transfer'
@ -217,10 +213,10 @@ module Epp
return true if Setting.client_status_editing_enabled return true if Setting.client_status_editing_enabled
return true if check_client_hold return true if check_client_hold
return true if params[:parsed_frame].css('status').empty? return true if params[:parsed_frame].css('status').empty?
epp_errors << { epp_errors.add(:epp_errors,
code: '2306', code: '2306',
msg: "#{I18n.t(:client_side_status_editing_error)}: status [status]" msg: "#{I18n.t(:client_side_status_editing_error)}: status [status]"
} )
end end
def check_client_hold def check_client_hold
@ -232,17 +228,15 @@ module Epp
@domain_pricelist = @domain.pricelist(operation, period.try(:to_i), unit) @domain_pricelist = @domain.pricelist(operation, period.try(:to_i), unit)
if @domain_pricelist.try(:price) # checking if price list is not found if @domain_pricelist.try(:price) # checking if price list is not found
if current_user.registrar.balance < @domain_pricelist.price.amount if current_user.registrar.balance < @domain_pricelist.price.amount
epp_errors << { epp_errors.add(:epp_errors,
code: '2104', code: '2104',
msg: I18n.t('billing_failure_credit_balance_low') msg: I18n.t('billing_failure_credit_balance_low'))
}
return false return false
end end
else else
epp_errors << { epp_errors.add(:epp_errors,
code: '2104', code: '2104',
msg: I18n.t(:active_price_missing_for_this_operation) msg: I18n.t(:active_price_missing_for_this_operation))
}
return false return false
end end
true true

4
app/controllers/epp/errors_controller.rb
View file

@ -3,12 +3,12 @@ module Epp
skip_authorization_check skip_authorization_check
def error def error
epp_errors << { code: params[:code], msg: params[:msg] } epp_errors.add(:epp_errors, code: params[:code], msg: params[:msg] )
render_epp_response '/epp/error' render_epp_response '/epp/error'
end end
def command_handler def command_handler
epp_errors << { code: '2000', msg: 'Unknown command' } epp_errors.add(:epp_errors, code: '2000', msg: 'Unknown command' )
render_epp_response '/epp/error' render_epp_response '/epp/error'
end end
end end

10
app/controllers/epp/polls_controller.rb
View file

@ -43,11 +43,11 @@ module Epp
@notification = current_user.unread_notifications.find_by(id: params[:parsed_frame].css('poll').first['msgID']) @notification = current_user.unread_notifications.find_by(id: params[:parsed_frame].css('poll').first['msgID'])
unless @notification unless @notification
epp_errors << { epp_errors.add(:epp_errors,
code: '2303', code: '2303',
msg: I18n.t('message_was_not_found'), msg: I18n.t('message_was_not_found'),
value: { obj: 'msgID', val: params[:parsed_frame].css('poll').first['msgID'] } value: { obj: 'msgID',
} val: params[:parsed_frame].css('poll').first['msgID'] })
handle_errors and return handle_errors and return
end end

63
app/controllers/epp/sessions_controller.rb
View file

@ -20,10 +20,9 @@ module Epp
server_md5 = Certificate.parse_md_from_string(File.read(ENV['cert_path'])) server_md5 = Certificate.parse_md_from_string(File.read(ENV['cert_path']))
if client_md5 != server_md5 if client_md5 != server_md5
epp_errors << { epp_errors.add(:epp_errors,
msg: 'Authentication error; server closing connection (certificate is not valid)', msg: 'Authentication error; server closing connection (certificate is not valid)',
code: '2501' code: '2501')
}
success = false success = false
end end
@ -32,56 +31,50 @@ module Epp
if !Rails.env.development? && (!webclient_request && @api_user) if !Rails.env.development? && (!webclient_request && @api_user)
unless @api_user.pki_ok?(request.env['HTTP_SSL_CLIENT_CERT'], unless @api_user.pki_ok?(request.env['HTTP_SSL_CLIENT_CERT'],
request.env['HTTP_SSL_CLIENT_S_DN_CN']) request.env['HTTP_SSL_CLIENT_S_DN_CN'])
epp_errors << { epp_errors.add(:epp_errors,
msg: 'Authentication error; server closing connection (certificate is not valid)', msg: 'Authentication error; server closing connection (certificate is not valid)',
code: '2501' code: '2501')
}
success = false success = false
end end
end end
if success && !@api_user if success && !@api_user
epp_errors << { epp_errors.add(:epp_errors,
msg: 'Authentication error; server closing connection (API user not found)', msg: 'Authentication error; server closing connection (API user not found)',
code: '2501' code: '2501')
}
success = false success = false
end end
if success && !@api_user.try(:active) if success && !@api_user.try(:active)
epp_errors << { epp_errors.add(:epp_errors,
msg: 'Authentication error; server closing connection (API user is not active)', msg: 'Authentication error; server closing connection (API user is not active)',
code: '2501' code: '2501')
}
success = false success = false
end end
if success && @api_user.cannot?(:create, :epp_login) if success && @api_user.cannot?(:create, :epp_login)
epp_errors << { epp_errors.add(:epp_errors,
msg: 'Authentication error; server closing connection (API user does not have epp role)', msg: 'Authentication error; server closing connection (API user does not have epp role)',
code: '2501' code: '2501')
}
success = false success = false
end end
if success && !ip_white? if success && !ip_white?
epp_errors << { epp_errors.add(:epp_errors,
msg: 'Authentication error; server closing connection (IP is not whitelisted)', msg: 'Authentication error; server closing connection (IP is not whitelisted)',
code: '2501' code: '2501')
}
success = false success = false
end end
if success && EppSession.limit_reached?(@api_user.registrar) if success && EppSession.limit_reached?(@api_user.registrar)
epp_errors << { epp_errors.add(:epp_errors,
msg: 'Session limit exceeded; server closing connection (connection limit reached)', msg: 'Session limit exceeded; server closing connection (connection limit reached)',
code: '2502', code: '2502')
}
success = false success = false
end end
@ -98,10 +91,9 @@ module Epp
already_authenticated = EppSession.exists?(session_id: epp_session_id) already_authenticated = EppSession.exists?(session_id: epp_session_id)
if already_authenticated if already_authenticated
epp_errors << { epp_errors.add(:epp_errors,
msg: 'Command use error; Already authenticated', msg: 'Command use error; Already authenticated',
code: 2002, code: 2002)
}
handle_errors handle_errors
return return
end end
@ -127,10 +119,9 @@ module Epp
def logout def logout
unless signed_in? unless signed_in?
epp_errors << { epp_errors.add(:epp_errors,
code: 2201, code: 2201,
msg: 'Authorization error' msg: 'Authorization error')
}
handle_errors handle_errors
return return
end end

31
app/models/concerns/epp_errors.rb
View file

@ -5,35 +5,41 @@ module EppErrors
end end
def construct_epp_errors def construct_epp_errors
epp_errors = [] epp_errors = ActiveModel::Errors.new(self)
errors.each do |error| errors.each do |error|
attr = error.attribute.to_s.split('.')[0].to_sym attr = error.attribute.to_s.split('.')[0].to_sym
next if attr == :epp_errors next if attr == :epp_errors
if self.class.reflect_on_association(attr) if self.class.reflect_on_association(attr)
epp_errors << collect_child_errors(attr) collect_child_errors(attr).each do |child_error|
epp_errors.import child_error
end
end end
if self.class.reflect_on_aggregation(attr) if self.class.reflect_on_aggregation(attr)
aggregation = send(attr) aggregation = send(attr)
epp_errors << collect_aggregation_errors(aggregation) collect_aggregation_errors(aggregation).each do |aggregation_error|
epp_errors.import aggregation_error
end
next next
end end
collect_parent_errors(attr, error.message).each do |parent_error|
epp_errors << collect_parent_errors(attr, error.message) epp_errors.import parent_error
end
end end
errors.add(:epp_errors, epp_errors.flatten) unless epp_errors.empty? epp_errors.each { |epp_error| errors.import epp_error}
errors
end end
def collect_parent_errors(attr, errors) def collect_parent_errors(attr, errors)
errors = [errors] if errors.is_a?(String) errors = [errors] if errors.is_a?(String)
epp_errors = [] epp_errors = ActiveModel::Errors.new(self)
errors.each do |err| errors.each do |err|
code, value = find_epp_code_and_value(err) code, value = find_epp_code_and_value(err)
next unless code next unless code
msg = attr.to_sym == :base ? err : "#{err} [#{attr}]" msg = attr.to_sym == :base ? err : "#{err} [#{attr}]"
epp_errors << { code: code, msg: msg, value: value } epp_errors.add(attr, code: code, msg: msg, value: value)
end end
epp_errors epp_errors
end end
@ -41,12 +47,13 @@ module EppErrors
def collect_child_errors(attr) def collect_child_errors(attr)
macro = self.class.reflect_on_association(attr).macro macro = self.class.reflect_on_association(attr).macro
multi = [:has_and_belongs_to_many, :has_many] multi = [:has_and_belongs_to_many, :has_many]
# single = [:belongs_to, :has_one]
epp_errors = [] epp_errors = ActiveModel::Errors.new(self)
send(attr).each do |x| send(attr).each do |x|
x.errors.messages.each do |attribute, errors| x.errors.each do |error|
epp_errors << x.collect_parent_errors(attribute, errors) x.collect_parent_errors(error.attribute, error.message).each do |parent_error|
epp_errors.import parent_error
end
end end
end if multi.include?(macro) end if multi.include?(macro)

4
app/views/epp/error.xml.builder
View file

@ -1,6 +1,8 @@
xml.epp_head do xml.epp_head do
xml.response do xml.response do
@errors.each do |x| @errors.each do |error|
x = error&.options
next if x.empty?
xml.result('code' => x[:code]) do xml.result('code' => x[:code]) do
xml.msg(x[:msg], 'lang' => 'en') xml.msg(x[:msg], 'lang' => 'en')
model_name = resource ? resource.model_name.singular.sub('epp_','') : controller.controller_name.singularize model_name = resource ? resource.model_name.singular.sub('epp_','') : controller.controller_name.singularize