borgmatic-collective/borgmatic
borgmatic-collective/borgmatic
Watch
9
74
Fork
You've already forked borgmatic
 57
Code Issues 71 Pull requests 3 Releases 162 Packages 1 Activity Actions 1

Default systemd credential name is rejected #1044

New issue
Closed
opened 2025-03-26 14:31:04 +00:00 by BenWolsieffer · 4 comments
BenWolsieffer commented 2025-03-26 14:31:04 +00:00
Copy link

What I'm trying to do and why

I am attempting to use the recently added systemd credential support, using the hardcoded default credential name (borgmatic.pw) in the systemd unit file.

Steps to reproduce

Follow the instructions in the manual for setting up systemd service credentials, using the built-in credential support rather than encryption_passcommand.

Actual behavior

CRITICAL /etc/borgmatic/config.yaml: /etc/borgmatic/config.yaml: Error getting local Borg version
CRITICAL /etc/borgmatic/config.yaml: Cannot load invalid credential name "borgmatic.pw"
CRITICAL /etc/borgmatic/config.yaml: An error occurred
CRITICAL
CRITICAL summary:
CRITICAL An error occurred
CRITICAL /etc/borgmatic/config.yaml: Error getting local Borg version
CRITICAL Cannot load invalid credential name "borgmatic.pw"
CRITICAL
CRITICAL Need some help? https://torsion.org/borgmatic/#issues

Expected behavior

The credential loads successfully.

Other notes / implementation ideas

It looks like this happens because the systemd credential loader requires the name to match the regex ^\w+$. This does not allow the . character, therefore the default credential name is rejected. I think either the regex should be made less restrictive or the default name should be changed.

borgmatic version

1.9.14

borgmatic installation method

Arch Linux package

Borg version

1.4.0

Python version

3.13.2

Database version (if applicable)

No response

Operating system and version

Arch Linux

### What I'm trying to do and why I am attempting to use the recently added systemd credential support, using the hardcoded default credential name (`borgmatic.pw`) in the systemd unit file. ### Steps to reproduce Follow the [instructions in the manual for setting up systemd service credentials](https://torsion.org/borgmatic/docs/how-to/provide-your-passwords/#systemd-service-credentials), using the built-in credential support rather than `encryption_passcommand`. ### Actual behavior ``` CRITICAL /etc/borgmatic/config.yaml: /etc/borgmatic/config.yaml: Error getting local Borg version CRITICAL /etc/borgmatic/config.yaml: Cannot load invalid credential name "borgmatic.pw" CRITICAL /etc/borgmatic/config.yaml: An error occurred CRITICAL CRITICAL summary: CRITICAL An error occurred CRITICAL /etc/borgmatic/config.yaml: Error getting local Borg version CRITICAL Cannot load invalid credential name "borgmatic.pw" CRITICAL CRITICAL Need some help? https://torsion.org/borgmatic/#issues ``` ### Expected behavior The credential loads successfully. ### Other notes / implementation ideas It looks like this happens because the systemd credential loader requires the name to match the regex `^\w+$`. This does not allow the `.` character, therefore the default credential name is rejected. I think either the regex should be made less restrictive or the default name should be changed. ### borgmatic version 1.9.14 ### borgmatic installation method Arch Linux package ### Borg version 1.4.0 ### Python version 3.13.2 ### Database version (if applicable) _No response_ ### Operating system and version Arch Linux
witten commented 2025-03-26 16:45:57 +00:00
Owner
Copy link

Thanks for filing this! You are absolutely right about the cause here. I'll make the regular expression less restrictive. (It's so restrictive right now to prevent path injection attacks.)

Thanks for filing this! You are absolutely right about the cause here. I'll make the regular expression less restrictive. (It's so restrictive right now to prevent path injection attacks.)
witten commented 2025-03-26 16:56:30 +00:00
Owner
Copy link

This is fixed in main and will be part of the next release! If you want to get the fix locally before then and don't mind modifying your local borgmatic install, you could update the regular expression yourself.

Thanks again!

This is fixed in main and will be part of the next release! If you want to get the fix locally before then and don't mind modifying your local borgmatic install, you could update the [regular expression](https://projects.torsion.org/borgmatic-collective/borgmatic/src/commit/d2714cb706c45ccc05f4890bedfa2d97e4e194ee/borgmatic/hooks/credential/systemd.py#L8) yourself. Thanks again!
witten 2025-03-26 16:56:30 +00:00
  • closed this issue
  • added the
    bug
         label
witten referenced this issue from a commit 2025-03-26 16:58:08 +00:00
Fix typo in NEWS (#1044).
BenWolsieffer commented 2025-03-27 23:25:38 +00:00
Author
Copy link

Thank you!

Thank you!
👍 1
witten commented 2025-04-06 15:43:33 +00:00
Owner
Copy link

Released in borgmatic 2.0.0!

Released in borgmatic 2.0.0!
Sign in to join this conversation.
No Branch/Tag specified
Branches Tags
main
parallel-borgmatic
command-hook-steps
2.1.7
2.1.6
2.1.5
2.1.4
2.1.3
2.1.2
2.1.1
2.1.0
2.0.13
2.0.12
2.0.11
2.0.10
2.0.9
2.0.8
2.0.7
2.0.6
2.0.5
2.0.4
2.0.3
2.0.2
2.0.1
2.0.0
1.9.14
1.9.13
1.9.12
1.9.11
1.9.10
1.9.9
1.9.8
1.9.7
1.9.6
1.9.5
1.9.4
1.9.3
1.9.2
1.9.1
1.9.0
1.8.14
1.8.13
1.8.12
1.8.11
1.8.10
1.8.9
1.8.8
1.8.7
1.8.6
1.8.5
1.8.4
1.8.3
1.8.2
1.8.1
1.8.0
1.7.15
1.7.14
1.7.13
1.7.12
1.7.11
1.7.10
1.7.9
1.7.8
1.7.7
1.7.6
1.7.5
1.7.4
1.7.3
1.7.2
1.7.1
1.7.0
1.6.6
1.6.5
1.6.4
1.6.3
1.6.2
1.6.1
1.6.0
1.5.24
1.5.23
1.5.22
1.5.21
1.5.20
1.5.19
1.5.18
1.5.17
1.5.16
1.5.15
1.5.14
1.5.13
1.5.12
1.5.11
1.5.10
1.5.9
1.5.8
1.5.7
1.5.7.dev0
1.5.6
1.5.5
1.5.4
1.5.3
1.5.2
1.5.1
1.5.0
1.4.22
1.4.21
1.4.20
1.4.19
1.4.18
1.4.17
1.4.16
1.4.15
1.4.14
1.4.13
1.4.12
1.4.11
1.4.10
1.4.9
1.4.8
1.4.7
1.4.6
1.4.5
1.4.4
1.4.3
1.4.2
1.4.1
1.4.0
1.3.26
1.3.25
1.3.24
1.3.23
1.3.22
1.3.21
1.3.20
1.3.19
1.3.18
1.3.17
1.3.16
1.3.15
1.3.14
1.3.13
1.3.12
1.3.11
1.3.10
1.3.9
1.3.8
1.3.7
1.3.6
1.3.5
1.3.4
1.3.3
1.3.2
1.3.1
1.3.0
1.2.18
1.2.17
1.2.16
1.2.15
1.2.14
1.2.13
1.2.12
1.2.11
1.2.10
1.2.9
1.2.8
1.2.7
1.2.6
1.2.5
1.2.4
1.2.3
1.2.2
1.2.1
1.2.0
1.1.15
1.1.14
1.1.13
1.1.12
1.1.11
1.1.10
1.1.9
1.1.7
1.1.6
1.1.5
1.1.4
1.1.3
1.1.2
1.1.1
1.1.0
1.0.3
1.0.2
1.0.1
1.0.0
0.1.8
0.1.7
0.1.6
0.1.5
0.1.4
0.1.3
0.1.2
0.1.1
0.1.0
0.0.7
0.0.6
0.0.5
0.0.4
0.0.3
0.0.2
Labels
Clear labels   
blocked

   
breaking

   
bug

   
data loss

   
design finalized

   
good first issue

   
new feature area

   
question / support

   
security

   
waiting for response
No labels
blocked
breaking
bug
data loss
design finalized
good first issue
new feature area
question / support
security
waiting for response
Milestone
Clear milestone
No items
No milestone
Assignees
Clear assignees
No assignees
2 participants
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set

Reference
borgmatic-collective/borgmatic#1044
No description provided.