Branch data     Line data    Source code

       1                 :            : /*
       2                 :            : ** Copyright (C) 2023 Sylvain Fargier
       3                 :            : **
       4                 :            : ** This software is provided 'as-is', without any express or implied
       5                 :            : ** warranty.  In no event will the authors be held liable for any damages
       6                 :            : ** arising from the use of this software.
       7                 :            : **
       8                 :            : ** Permission is granted to anyone to use this software for any purpose,
       9                 :            : ** including commercial applications, and to alter it and redistribute it
      10                 :            : ** freely, subject to the following restrictions:
      11                 :            : **
      12                 :            : ** 1. The origin of this software must not be misrepresented; you must not
      13                 :            : **    claim that you wrote the original software. If you use this software
      14                 :            : **    in a product, an acknowledgment in the product documentation would be
      15                 :            : **    appreciated but is not required.
      16                 :            : ** 2. Altered source versions must be plainly marked as such, and must not be
      17                 :            : **    misrepresented as being the original software.
      18                 :            : ** 3. This notice may not be removed or altered from any source distribution.
      19                 :            : **
      20                 :            : ** Created on: 2023-12-12T19:29:24
      21                 :            : ** Author: Sylvain Fargier <fargier.sylvain@gmail.com>
      22                 :            : */
      23                 :            : 
      24                 :            : #ifndef ICMPSOCKET_HPP__
      25                 :            : #define ICMPSOCKET_HPP__
      26                 :            : 
      27                 :            : #include "../Socket.hpp"
      28                 :            : 
      29                 :            : namespace ccut {
      30                 :            : namespace net {
      31                 :            : 
      32                 :            : struct ICMPMessage;
      33                 :            : 
      34                 :            : /**
      35                 :            :  * @brief ICMP communication socket
      36                 :            :  * @details this socket can only be used in ipv4
      37                 :            :  * @details to use the entire ICMP protocol your exe will require
      38                 :            :  * `cap_net_raw=ep` permission: `setcap cap_net_raw=ep {exe}`
      39                 :            :  */
      40                 :            : class ICMPSocket : public Socket<ICMPMessage>
      41                 :            : {
      42                 :            : public:
      43                 :            :     explicit ICMPSocket(const std::string &name = "ICMPSocket");
      44                 :          3 :     virtual ~ICMPSocket() = default;
      45                 :            : 
      46                 :            :     /**
      47                 :            :      * @brief check if socket is opened in raw mode
      48                 :            :      * @return true if socket is opened in RAW mode
      49                 :            :      * @return false if socket is opened in DGRAM (Linux only) or closed
      50                 :            :      */
      51                 :            :     bool isRaw();
      52                 :            : 
      53                 :            : protected:
      54                 :            :     int makeSocket(bool v6) override;
      55                 :            :     Message processMessage(const address_t &from,
      56                 :            :                            const address_t &to,
      57                 :            :                            const cow_ptr<buffer_t> &buffer) override;
      58                 :            : 
      59                 :            :     bool m_isRaw;
      60                 :            : };
      61                 :            : 
      62                 :            : } // namespace net
      63                 :            : } // namespace ccut
      64                 :            : 
      65                 :            : #endif