File: ip_cidr_validator.rb

package info (click to toggle)
gitlab 17.6.5-19
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 629,368 kB
  • sloc: ruby: 1,915,304; javascript: 557,307; sql: 60,639; xml: 6,509; sh: 4,567; makefile: 1,239; python: 406
file content (45 lines) | stat: -rw-r--r-- 1,414 bytes parent folder | download
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
# frozen_string_literal: true

# IpCidrValidator
#
# Validates that an IP is a valid IPv4 or IPv6 CIDR address.
#
# Example:
#
#   class Group < ActiveRecord::Base
#     validates :ip, presence: true, ip_cidr: true
#   end

class IpCidrValidator < ActiveModel::EachValidator # rubocop:disable Gitlab/NamespacedClass -- This is a globally shareable validator, but it's unclear what namespace it should belong in
  def validate_each(record, attribute, value)
    # NOTE: We want this to be usable for nullable fields, so we don't validate presence.
    #       Use a separate `presence` validation for the field if needed.
    return true if value.blank?

    # rubocop:disable Layout/LineLength -- The error message is bigger than the line limit
    unless valid_cidr_format?(value)
      record.errors.add(
        attribute,
        format(_(
          "IP '%{value}' is not a valid CIDR: IP should be followed by a slash followed by an integer subnet mask (for example: '192.168.1.0/24')"),
          value: value
        )
      )
      return
    end
    # rubocop:enable Layout/LineLength

    IPAddress.parse(value)
  rescue ArgumentError => e
    record.errors.add(
      attribute,
      format(_("IP '%{value}' is not a valid CIDR: %{message}"), value: value, message: e.message)
    )
  end

  private

  def valid_cidr_format?(cidr)
    cidr.count('/') == 1 && cidr.split('/').last =~ /^\d+$/
  end
end