From c31a5c0d9c9db52f03caa443a3fdfdce194046e8 Mon Sep 17 00:00:00 2001
From: Paul Holzinger <paul.holzinger@web.de>
Date: Tue, 1 Dec 2020 22:12:16 +0100
Subject: Add support for network ids

The network ID is not stored. It is just the sha256 hash from
the network name. There is a risk of a potential hash collision.
However it's very unlikely and even if we hit this it will
complain that more than network with this ID exists.

The main benefit is that the compat api can have proper
network ID support. Also this adds the support for
`podman network ls --format "{{.ID}}"` and `--filter id=<ID>`.

It also ensures that we can do network rm <ID> and network
inspect <ID>.

Since we use a hash this commit is backwards compatible even for
already existing networks.

Signed-off-by: Paul Holzinger <paul.holzinger@web.de>
---
 libpod/network/files.go       | 18 +++++++++++++++---
 libpod/network/netconflist.go | 10 +++++++++-
 libpod/network/network.go     | 11 ++++++++++-
 3 files changed, 34 insertions(+), 5 deletions(-)

(limited to 'libpod')

diff --git a/libpod/network/files.go b/libpod/network/files.go
index 83cb1c23a..33cf01064 100644
--- a/libpod/network/files.go
+++ b/libpod/network/files.go
@@ -50,13 +50,15 @@ func LoadCNIConfsFromDir(dir string) ([]*libcni.NetworkConfigList, error) {
 	return configs, nil
 }
 
-// GetCNIConfigPathByName finds a CNI network by name and
+// GetCNIConfigPathByNameOrID finds a CNI network by name and
 // returns its configuration file path
-func GetCNIConfigPathByName(config *config.Config, name string) (string, error) {
+func GetCNIConfigPathByNameOrID(config *config.Config, name string) (string, error) {
 	files, err := libcni.ConfFiles(GetCNIConfDir(config), []string{".conflist"})
 	if err != nil {
 		return "", err
 	}
+	idMatch := 0
+	file := ""
 	for _, confFile := range files {
 		conf, err := libcni.ConfListFromFile(confFile)
 		if err != nil {
@@ -65,6 +67,16 @@ func GetCNIConfigPathByName(config *config.Config, name string) (string, error)
 		if conf.Name == name {
 			return confFile, nil
 		}
+		if strings.HasPrefix(GetNetworkID(conf.Name), name) {
+			idMatch++
+			file = confFile
+		}
+	}
+	if idMatch == 1 {
+		return file, nil
+	}
+	if idMatch > 1 {
+		return "", errors.Errorf("more than one result for network ID %s", name)
 	}
 	return "", errors.Wrap(define.ErrNoSuchNetwork, fmt.Sprintf("unable to find network configuration for %s", name))
 }
@@ -72,7 +84,7 @@ func GetCNIConfigPathByName(config *config.Config, name string) (string, error)
 // ReadRawCNIConfByName reads the raw CNI configuration for a CNI
 // network by name
 func ReadRawCNIConfByName(config *config.Config, name string) ([]byte, error) {
-	confFile, err := GetCNIConfigPathByName(config, name)
+	confFile, err := GetCNIConfigPathByNameOrID(config, name)
 	if err != nil {
 		return nil, err
 	}
diff --git a/libpod/network/netconflist.go b/libpod/network/netconflist.go
index a5fec5e80..d61b96ecb 100644
--- a/libpod/network/netconflist.go
+++ b/libpod/network/netconflist.go
@@ -230,8 +230,16 @@ func IfPassesFilter(netconf *libcni.NetworkConfigList, filters map[string][]stri
 				}
 			}
 
+		case "id":
+			// matches part of one id
+			for _, filterValue := range filterValues {
+				if strings.Contains(GetNetworkID(netconf.Name), filterValue) {
+					result = true
+					break
+				}
+			}
+
 		// TODO: add dangling filter
-		// TODO TODO: add id filter if we support ids
 
 		default:
 			return false, errors.Errorf("invalid filter %q", key)
diff --git a/libpod/network/network.go b/libpod/network/network.go
index 0febb52f6..89f0b67ac 100644
--- a/libpod/network/network.go
+++ b/libpod/network/network.go
@@ -1,6 +1,8 @@
 package network
 
 import (
+	"crypto/sha256"
+	"encoding/hex"
 	"encoding/json"
 	"net"
 	"os"
@@ -175,7 +177,7 @@ func RemoveNetwork(config *config.Config, name string) error {
 		return err
 	}
 	defer l.releaseCNILock()
-	cniPath, err := GetCNIConfigPathByName(config, name)
+	cniPath, err := GetCNIConfigPathByNameOrID(config, name)
 	if err != nil {
 		return err
 	}
@@ -229,3 +231,10 @@ func Exists(config *config.Config, name string) (bool, error) {
 	}
 	return true, nil
 }
+
+// GetNetworkID return the network ID for a given name.
+// It is just the sha256 hash but this should be good enough.
+func GetNetworkID(name string) string {
+	hash := sha256.Sum256([]byte(name))
+	return hex.EncodeToString(hash[:])
+}
-- 
cgit v1.2.3-54-g00ecf