| // Copyright (c) 2012 The Chromium Authors. All rights reserved. |
| // Use of this source code is governed by a BSD-style license that can be |
| // found in the LICENSE file. |
| |
| #ifndef NET_BASE_PORT_UTIL_H_ |
| #define NET_BASE_PORT_UTIL_H_ |
| |
| #include <stddef.h> |
| #include <stdint.h> |
| |
| #include "base/containers/span.h" |
| #include "base/strings/string_piece.h" |
| #include "net/base/net_export.h" |
| |
| namespace net { |
| |
| // Checks if |port| is in the valid range (0 to 65535, though 0 is technically |
| // reserved). Should be used before casting a port to a uint16_t. |
| NET_EXPORT bool IsPortValid(int port); |
| |
| // Returns true if the port is in the range [0, 1023]. These ports are |
| // registered by IANA and typically need root access to listen on. |
| NET_EXPORT bool IsWellKnownPort(int port); |
| |
| // Checks if the port is allowed for the specified scheme. Ports set as allowed |
| // with SetExplicitlyAllowedPorts() or by using ScopedPortException() will be |
| // considered allowed for any scheme. |
| NET_EXPORT bool IsPortAllowedForScheme(int port, base::StringPiece url_scheme); |
| |
| // Returns the number of explicitly allowed ports; for testing. |
| NET_EXPORT_PRIVATE size_t GetCountOfExplicitlyAllowedPorts(); |
| |
| // Set the list of ports to be allowed that otherwise would not be. This |
| // replaces the list of allowed ports with the list passed to this function. An |
| // empty list will remove all ports. This will reset any ScopedPortExceptions |
| // currently active, so it's best to avoid calling this when any of those are |
| // active. |
| NET_EXPORT void SetExplicitlyAllowedPorts( |
| base::span<const uint16_t> allowed_ports); |
| |
| // Returns true for ports which are permitted to be passed to |
| // SetExplicitlyAllowedPorts(). This is not currently enforced by |
| // SetExplicitlyAllowedPorts() itself, as there are still callers that pass |
| // other ports. |
| NET_EXPORT bool IsAllowablePort(int port); |
| |
| class NET_EXPORT ScopedPortException { |
| public: |
| explicit ScopedPortException(int port); |
| ScopedPortException(const ScopedPortException&) = delete; |
| ScopedPortException& operator=(const ScopedPortException&) = delete; |
| ~ScopedPortException(); |
| |
| private: |
| int port_; |
| }; |
| |
| // Adds a port to the set permitted by GetAllowablePorts(). Cannot be nested. |
| class NET_EXPORT ScopedAllowablePortForTesting { |
| public: |
| explicit ScopedAllowablePortForTesting(int port); |
| ScopedAllowablePortForTesting(const ScopedAllowablePortForTesting&) = delete; |
| ScopedAllowablePortForTesting& operator=( |
| const ScopedAllowablePortForTesting&) = delete; |
| ~ScopedAllowablePortForTesting(); |
| }; |
| |
| } // namespace net |
| |
| #endif // NET_BASE_PORT_UTIL_H_ |