Add --askpin option #130
Add --askpin option #130
Conversation
Adding --askpin option modeled after --askpass, letting people enter pin early int he startup or more importantly allow them to keep a password in separate file to simplify unattended setup. Signed-off-by: Michal Hrusecky <Michal@Hrusecky.net>
| token_pass.nocache = true; | ||
|
|
||
| if (!strlen(token_pass.password)) | ||
| { |
|
It wasn't clear that this was about PKCS#11. How about renaming the option to --pkcs11-askpin ? I think it'll be much more self explanatory. At the same time I'd extend the doc a little bit to mention what the pin is for. May be obvious for you or me looking at the code, but not for the casual reader. @miska if still interested, how about addressing these changes and sending the patch to the mailing list, please? |
|
Since it's a violation of security (to a varying degree, the file/config may be on an encrypted file system), it may be nice to go the full way of and A process who can read the PIN file must have access to the config (and vice versa) anyway. And it's still (kind of) more secure than |
|
Would really love to see this feature and I would volunteer to bring the development forward. @ordex @becm could you please summarize your preferred way of implementing this? For me a new option |
|
Maybe @dsommers could be more helpful here |
|
For me, it just felt like this should behave more like a config option that supports inline PIN data. Required presence of the token should still make this more secure than traditional The behavioral difference would also enhance the use of a new option ( I'm not in any position to advise on or green-light implementation though. 😉 |
|
I would also like to bring this development forward. Is it possible? @dsommers @ordex @becm Would it be possible to also accommodate @R0Wi’s request? I can volunteer to make the changes myself, as long as someone can explain the correct way to do it.
|
|
If anyone is interested in a workaround: In the meantime I solved this by using the OpenVPN Management Interface to provide the PKCS11 pin at runtime. Step 1: Add this to your Step 2: Create a tcp client which connects to the OpenVPN Management Interface on import socket
import time
import argparse
import logging
import sys
import signal
from logging.handlers import RotatingFileHandler
EXPECTED_MESSAGE = ">PASSWORD:Need 'OpenPGP card (User PIN) token' password"
running = True
def read_pin_from_file(file):
with open(file) as pin_file_res:
return pin_file_res.read().strip()
def read_ovpn_management_settings(file):
with open(file) as ovpn_file_res:
content_lines = ovpn_file_res.read().split("\n")
for line in content_lines:
if line.startswith("management "):
parts = line.split()
# management <listen_addr> <port>
return parts[1], int(parts[2])
def handle_sigterm(signum, frame):
global running
logging.info("Handling SIGTERM")
running = False
raise KeyboardInterrupt("SIGTERM received, shutting down...")
def main(logfile, pinfile, ovpnconfig):
global running
if logfile:
handler = RotatingFileHandler(logfile, maxBytes=5*1024*1024, backupCount=3)
logging.basicConfig(handlers=[handler], level=logging.INFO, format='%(asctime)s %(message)s')
else:
logging.basicConfig(stream=sys.stdout, level=logging.INFO, format='%(asctime)s %(message)s')
pin = read_pin_from_file(pinfile)
management_addr, management_port = read_ovpn_management_settings(ovpnconfig)
signal.signal(signal.SIGTERM, handle_sigterm)
with socket.socket(socket.AF_INET, socket.SOCK_STREAM) as s:
while running:
try:
s.connect((management_addr, management_port))
break
except ConnectionRefusedError:
logging.info(f"Connection refused to {management_addr}:{management_port}, retrying in 2 seconds...")
time.sleep(2)
logging.info("Connected to OVPN management interface, start listening ...")
while running:
try:
data = s.recv(1024)
except KeyboardInterrupt:
logging.info("KeyboardInterrupt received, exiting...")
break
if not data:
logging.info("Connection closed, exiting...")
break
messages = filter(lambda msg: msg != '', [message.strip() for message in data.decode('utf-8').split("\n")])
for message in messages:
logging.info(f"Received: {message}")
if message == EXPECTED_MESSAGE:
logging.info("Providing password...")
answer = "password 'OpenPGP card (User PIN) token' '" + pin + "'\n"
s.sendall(answer.encode('utf-8'))
logging.info("Program ended properly")
if __name__ == "__main__":
parser = argparse.ArgumentParser(description='Provide PCKS11 PIN for OpenVPN')
parser.add_argument('--logfile', type=str, help='Path to the log file. If not set, messages will be printed to stdout')
parser.add_argument('--pinfile', type=str, help='Path to the pin file where the pin to be provided is stored (default: /etc/openvpn/pin)', default='/etc/openvpn/pin')
parser.add_argument('--ovpnconfig', type=str, help='Path to the OpenVPN config file (default: /etc/openvpn/client.conf)', default='/etc/openvpn/client.conf')
args = parser.parse_args()
main(args.logfile, args.pinfile, args.ovpnconfig)Adjust the Step 3: Ensure that the client is started together with your openvpn instance. If you're using systemd, use a service file like this Again, adjust the parameters to your needs. You might also want to add a dependency to the openvpn service itself by creating Don't forget to do a |
Adding --askpin option modeled after --askpass, letting people enter pin early
int he startup or more importantly allow them to keep a password in separate
file to simplify unattended setup.
Signed-off-by: Michal Hrusecky Michal@Hrusecky.net
Thank you for your contribution
You are welcome to open PR, but they are used for discussion only. All
patches must eventually go to the openvpn-devel mailing list for review:
Please send your patch using git-send-email. For example to send your latest commit to the list:
For details, see these Wiki articles: