ipfs/kubo

unix domain socket not removed if it exists

Open

#6,856 opened on Jan 31, 2020

View on GitHub
 (4 comments) (0 reactions) (0 assignees)Go (13,906 stars) (2,725 forks)batch import
help wantedkind/enhancementtopic/rpc-api

Description

When using a unix domain socket, config: "API": [ "/ip4/127.0.0.1/tcp/5001", "/unix/var/db/ipfs-go/socket/api.sock" ],

the first time it starts up, it works fine, but the second time it fails:

Error: serveHTTPApi: manet.Listen(/unix/var/db/ipfs-go/socket/api.sock) failed: listen unix /var/db/ipfs-go/socket/api.sock: bind: address already in use

It is common for programs to either use a lock file, or just simply remove it on start.

I've worked around the issue by removing it in my startup file, but a better solution that is more generic would be nice.

Contributor guide

Tech stack
go
Domain
backend
Issue type
bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Go programming languageBasic understanding of Unix domain sockets
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85
Research direction
Investigate the HTTP API server initialization in the repository, specifically the function that creates the listener for Unix sockets. The issue requires that before listening on a Unix socket, the program should check if the socket file already exists and remove it. Look at the code in `cmd/ipfs/` or `core/` directories where the API server is started. The fix would involve adding a call to `os.Remove()` before `net.Listen()` when the address is a Unix socket. Ensure that the removal is done only if the file is a socket (not a regular file) to avoid accidental deletion.
unix domain socket not removed if it exists · ipfs/kubo#6856 | Good First Issue