├── README.md
└── sss


/README.md:
--------------------------------------------------------------------------------
 1 | <div align="center"><p align="center"><img src="https://gnos.in/img/shot/common/gnos-sockets_0.png"></img></p></div>
 2 | 
 3 | # GNOS Sockets
 4 | 
 5 | List IP sockets
 6 | 
 7 | - auto-sudo
 8 | - sane CLI args & defaults
 9 | - meaningful color scheme
10 | - searchable sorted output
11 | - shortened addresses (0.0.0.0 -> 0, 127.0.0.1 -> 1)
12 | 
13 | ## Usage
14 | 
15 | ```
16 | Usage: sss [ options ] [ PATTERN ]
17 | 
18 |   -4       Display only IPv4 sockets
19 |   -6       Display only IPv6 sockets
20 |   -t       Display only TCP sockets
21 |   -u       Display only UDP sockets
22 |   -l       Display only listening sockets
23 |   -L       Display only non-listening sockets
24 |   -s       Display short IP
25 |   -N       Resolve numerics
26 |   PATTERN  Plain-text match
27 | ```
28 | 
29 | If you have the habit of `ss -tupln`, you can use the same with `sss -tupln`, unknown parameters will not disturb the output.
30 | 
31 | ## Install
32 | ### APT
33 | Use the repository https://packages.azlux.fr/ and install with `apt update` and `apt install sss`
34 | 
35 | ### Manually (no auto-update)
36 | Just copy somewhere in your `$PATH`.
37 | 
38 | Depends: `ss` `sed` `awk` `sort` `column` `sudo`.
39 | 


--------------------------------------------------------------------------------
/sss:
--------------------------------------------------------------------------------
  1 | #!/usr/bin/env bash
  2 | # NAME:  GNOS sockets
  3 | # DESC:  Handy ss wrapper
  4 | # FEAT:  Colors support
  5 | # DEPS:  ss sed awk sort column sudo
  6 | # LICE:  WTFPL
  7 | # AUTH:  elias@gnos.in
  8 | 
  9 | 
 10 | ########
 11 | # FUNC #
 12 | ########
 13 | 
 14 | Usage () # $1:RET
 15 | {
 16 |     cat <<EOF
 17 | Usage: $( basename "$( readlink -f "$BASH_SOURCE" )" ) [ options ] [ PATTERN ]
 18 | 
 19 |   -4       Display only IPv4 sockets
 20 |   -6       Display only IPv6 sockets
 21 |   -t       Display only TCP sockets
 22 |   -u       Display only UDP sockets
 23 |   -l       Display only listening sockets
 24 |   -L       Display only non-listening sockets
 25 |   -s       Display short IP
 26 |   -N       Resolve numerics
 27 |   PATTERN  Plain-text match
 28 | EOF
 29 |     exit $1
 30 | }
 31 | 
 32 | Fix ()
 33 | {
 34 |     sed -E -e 's/^([a-z0-9]+)([A-Z])/\1 \2/' \
 35 |            -e 's/^([A-Z-]+)([0-9])/\1 \2/'
 36 | }
 37 | 
 38 | Render () # $1:COLORS $2:PROTO_SUFFIX $3:PATTERN $4:LISTEN $5:NUMERIC $6:FORCE $7:SHORT
 39 | {
 40 |     awk -v colors=$1 -v suffix=$2 -v pattern="$3" -v listen=$4 -v numeric=$5 -v force=$6 -v short=$7 \
 41 |         -v username=${SUDO_USER:-$USER} -v hostname=$HOSTNAME '
 42 | 
 43 |     BEGIN {
 44 |         unknown=":"
 45 | 
 46 |         # Colors
 47 |         creset="\033[0m"
 48 |         cbold="\033[1m"
 49 |         cred="\033[31m"
 50 |         cgreen="\033[32m"
 51 |         cyellow="\033[33m"
 52 |         cblue="\033[34m"
 53 | 
 54 |         # Usernames by pid
 55 |         cmd="ps --no-headers -eo pid,user"
 56 |         while (cmd | getline v)
 57 |         {
 58 |             gsub("^ +" , "", v)
 59 |             i=index(v, " ")
 60 |             users[substr(v, 1, i-1)+0]=substr(v, i+1)
 61 |         }
 62 |         close(cmd)
 63 | 
 64 |         # Local ips
 65 |         cmd="ip a"
 66 |         while (cmd | getline )
 67 |         {
 68 |             if ($1=="inet" || $1=="inet6") locals[ substr($2, 1, index($2, "/")-1) ] = 1
 69 |         }
 70 |         close(cmd)
 71 |     }
 72 | 
 73 |     {
 74 |         # Init
 75 |         nolport=0
 76 | 
 77 |         # Mapping
 78 |         if (length(force))
 79 |         {
 80 |             proto=force
 81 |             state=$1
 82 |             local=$4
 83 |             remote=$5
 84 |             user=$6
 85 |         }
 86 |         else
 87 |         {
 88 |             proto=$1
 89 |             state=$2
 90 |             local=$5
 91 |             remote=$6
 92 |             user=$7
 93 |         }
 94 | 
 95 |         # PROTOCOL
 96 |         if (proto=="tcp" || proto=="udp") proto=proto suffix
 97 |         else nolport=1
 98 | 
 99 |         if (colors)
100 |         {
101 |             protov=""
102 |             if (substr(proto, length(proto))==6)
103 |             {
104 |                 proto=substr(proto, 1, length(proto)-1)
105 |                 protov=6
106 |             }
107 |             proto=ColorProto(proto) cred protov creset
108 |         }
109 | 
110 |         # LOCAL
111 |         laddr=FormatIp(local)
112 |         if (colors) laddr=ColorIp(laddr)
113 |         lport=local
114 |         gsub("^.*:" , "", lport)
115 |         if (nolport) lport=""
116 | 
117 |         # REMOTE
118 |         if (listen!=1 && force!="udp")
119 |         {
120 |             raddr=FormatIp(remote)
121 |             if (colors) raddr=ColorIp(raddr)
122 |             rport=remote
123 |             gsub("^.*:" , "", rport)
124 |         }
125 | 
126 |         # PROCESS, PID, UID
127 |         name=unknown
128 |         pid=unknown
129 |         uid=unknown
130 |         if (substr(user, 1, 6)=="users:")
131 |         {
132 |             name=substr(user, 10, index(user, "\",")-10)
133 | 
134 |             i=index(user, "=")
135 |             pid=substr(user, i+1)
136 |             i=index(pid, ",")
137 |             pid=substr(pid, 1, i-1)
138 | 
139 |             if (users[pid]) uid=users[pid]
140 |         }
141 |         if (colors) uid=ColorUser(uid)
142 | 
143 |         # STATE
144 |         if (state=="LISTEN" || state=="UNCONN")
145 |         {
146 |             raddr=""
147 |             rport=""
148 |         }
149 |         if (colors) state=ColorState(state)
150 | 
151 |         # Main
152 |         if (listen==1 || force=="udp" ) line=uid " " name " " pid " " proto " " laddr ":" lport " " state
153 |         else                            line=uid " " name " " pid " " proto " " laddr ":" lport " " raddr ":" rport " " state
154 | 
155 |         if (length(pattern))
156 |         {
157 |             # Filter
158 |             raw=" " line
159 |             gsub("\033\\[[0-9]+m" , "", raw)
160 |             # print raw
161 |             if (index(raw, pattern)) print line
162 |         }
163 |         else print line
164 |     }
165 |     function FormatIp(ip)
166 |     {
167 |         gsub("(:[^:]*|%.*)$" , "", ip)
168 |         if (short==1)
169 |         {
170 |             if (substr(ip, 1, 1)=="[") ip=substr(ip, 2, length(ip)-2)
171 |             if (substr(ip, 1, 7)=="::ffff:") ip=substr(ip, 8)
172 |             if (ip=="*" || ip=="0.0.0.0" || ip=="::") ip=0
173 |             if (substr(ip, 1, 4)=="127." || ip=="::1" || ip=="localhost") ip=1
174 |         }
175 |         return ip
176 |     }
177 |     function ColorIp(ip)
178 |     {
179 |         if (ip==0) return cred ip creset
180 |         else if (ip==1 || ip=="localhost" || substr(ip, 1, 4)=="127." ) return cgreen ip creset
181 |         else if (locals[ip]==1 || ip==hostname) return cblue ip creset
182 |         else return cyellow ip creset
183 |     }
184 |     function ColorProto(p)
185 |     {
186 |         if (p=="tcp") return cgreen p creset
187 |         else if (p=="udp") return cblue p creset
188 |         else return cyellow p creset
189 |     }
190 |     function ColorUser(u)
191 |     {
192 |         if (u=="root") return cred u creset
193 |         else if (u==username) return cgreen u creset
194 |         else if (u==unknown) return u
195 |         else return cyellow u creset
196 |     }
197 |     function ColorState(s)
198 |     {
199 |         if (s=="LISTEN") return cred s creset
200 |         else if (s=="ESTAB") return cgreen s creset
201 |         else if (s=="UNCONN") return cblue s creset
202 |         else return cyellow s creset
203 |     }
204 |     '
205 | }
206 | 
207 | 
208 | ########
209 | # INIT #
210 | ########
211 | 
212 | # DEFS
213 | args="$@"
214 | opts="--no-header --extended --processes"
215 | ipv=0
216 | tcp=0
217 | listen=0
218 | numeric=1
219 | short=0
220 | 
221 | # Colors
222 | [[ -t 1 && "$(tput colors)" -ge 8 ]] && colors=$(tput colors)
223 | cyellow='\033[33m'
224 | creset='\033[0m'
225 | cbold='\033[1m'
226 | 
227 | 
228 | # ARGS
229 | while getopts hNlL46tupns opt "$@" &>/dev/null ; do
230 |     case "$opt" in
231 | 
232 |         4)    [[ $ipv -eq 6 ]] && ipv=0 || ipv=4 ;;
233 |         6)    [[ $ipv -eq 4 ]] && ipv=0 || ipv=6 ;;
234 | 
235 |         t)    [[ $tcp -eq 2 ]] && tcp=3 || tcp=1 ;;
236 |         u)    [[ $tcp -eq 1 ]] && tcp=3 || tcp=2 ;;
237 | 
238 |         l)    [[ $listen -eq 2 ]] && listen=0 || listen=1 ;;
239 |         L)    [[ $listen -eq 1 ]] && listen=0 || listen=2 ;;
240 | 
241 |         N)    numeric=0 ;;
242 |         s)    short=1 ;;
243 | 
244 |         h)    Usage 0 ;;
245 |         [?])  Usage 1 ;;
246 |     esac
247 | done
248 | shift "$((OPTIND-1))"
249 | [[ $# -gt 1 ]] && Usage 1
250 | pattern=$1
251 | shift
252 | 
253 | # USER
254 | if [[ $( id -u ) -ne 0 ]] ; then
255 |     sudo "$( readlink -f "$BASH_SOURCE" )" $args && exit
256 |     [[ -n $colors ]] && echo -en $cyellow >&2
257 |     echo "WARNING: Running unprivileged"    >&2
258 |     [[ -n $colors ]] && echo -en $creset  >&2
259 | fi
260 | 
261 | # OPTS
262 | [[ $numeric -eq 1 ]] && opts="$opts --numeric" || opts="$opts --resolve"
263 | case $listen in
264 |     0) opts="$opts --all" ;;
265 |     1) opts="$opts --listen" ;;
266 | esac
267 | case $tcp in
268 |     0)    [[ $listen -eq 2 ]] \
269 |        && opts="$opts --tcp --udp" \
270 |        || opts="$opts --tcp --udp --raw" ;;
271 |     3)    opts="$opts --tcp --udp"       ;;
272 |     1)    opts="$opts --tcp" ; force=tcp ;;
273 |     2)    opts="$opts --udp" ; force=udp ;;
274 | esac
275 | 
276 | 
277 | ########
278 | # MAIN #
279 | ########
280 | 
281 | {
282 |     # Header
283 |     [[ -n $colors ]] && echo -en $cbold
284 |     if [[ $listen -eq 1 || $force == "udp" ]] ; then
285 |         echo -n USER PROCESS PID PROTO LOCAL STATE
286 |     else
287 |         echo -n USER PROCESS PID PROTO LOCAL REMOTE STATE
288 |     fi
289 |     [[ -n $colors ]] && echo -en $creset
290 |     echo
291 | 
292 |     # Data
293 |     {
294 |         [[ $ipv -eq 4 || $ipv -eq 0 ]] && ss $opts --ipv4 | Fix | Render "$colors" "" "$pattern" "$listen" "$numeric" "$force" "$short"
295 |         [[ $ipv -eq 6 || $ipv -eq 0 ]] && ss $opts --ipv6 | Fix | Render "$colors" 6  "$pattern" "$listen" "$numeric" "$force" "$short"
296 |     } | sort -n
297 | 
298 | } | column -t
299 | 


--------------------------------------------------------------------------------