1 // SPDX-License-Identifier: GPL-2.0-or-later
5 * Copyright (C) 2003 Paul Jakma.
6 * Copyright (c) 2005, 2011, Oracle and/or its affiliates. All rights reserved.
12 #include "frr_pthread.h"
13 #include "lib_errors.h"
14 #include "lib/queue.h"
16 DEFINE_MTYPE_STATIC(LIB
, PRIVS
, "Privilege information");
19 * Different capabilities/privileges apis have different characteristics: some
20 * are process-wide, and some are per-thread.
22 #ifdef HAVE_CAPABILITIES
24 static const bool privs_per_process
; /* = false */
26 static const bool privs_per_process
= true;
27 #endif /* HAVE_LCAPS */
28 #else /* HAVE_CAPABILITIES */
29 static const bool privs_per_process
= true;
32 #ifdef HAVE_CAPABILITIES
34 /* sort out some generic internal types for:
36 * privilege values (cap_value_t, priv_t) -> pvalue_t
37 * privilege set (..., priv_set_t) -> pset_t
38 * privilege working storage (cap_t, ...) -> pstorage_t
40 * values we think of as numeric (they're ints really, but we dont know)
41 * sets are mostly opaque, to hold a set of privileges, related in some way.
42 * storage binds together a set of sets we're interested in.
43 * (in reality: cap_value_t and priv_t are ints)
46 /* Linux doesn't have a 'set' type: a set of related privileges */
51 typedef cap_value_t pvalue_t
;
52 typedef struct _pset pset_t
;
53 typedef cap_t pstorage_t
;
56 #error "HAVE_CAPABILITIES defined, but neither LCAPS nor Solaris Capabilties!"
57 #endif /* HAVE_LCAPS */
58 #endif /* HAVE_CAPABILITIES */
60 /* the default NULL state we report is RAISED, but could be LOWERED if
61 * zprivs_terminate is called and the NULL handler is installed.
63 static zebra_privs_current_t zprivs_null_state
= ZPRIVS_RAISED
;
65 /* internal privileges state */
66 static struct _zprivs_t
{
67 #ifdef HAVE_CAPABILITIES
68 pstorage_t caps
; /* working storage */
69 pset_t
*syscaps_p
; /* system-type requested permitted caps */
70 pset_t
*syscaps_i
; /* system-type requested inheritable caps */
71 #endif /* HAVE_CAPABILITIES */
72 uid_t zuid
, /* uid to run as */
73 zsuid
; /* saved uid */
74 gid_t zgid
; /* gid to run as */
75 gid_t vtygrp
; /* gid for vty sockets */
78 /* externally exported but not directly accessed functions */
79 #ifdef HAVE_CAPABILITIES
80 int zprivs_change_caps(zebra_privs_ops_t
);
81 zebra_privs_current_t
zprivs_state_caps(void);
82 #endif /* HAVE_CAPABILITIES */
83 int zprivs_change_uid(zebra_privs_ops_t
);
84 zebra_privs_current_t
zprivs_state_uid(void);
85 int zprivs_change_null(zebra_privs_ops_t
);
86 zebra_privs_current_t
zprivs_state_null(void);
88 #ifdef HAVE_CAPABILITIES
89 /* internal capability API */
90 static pset_t
*zcaps2sys(zebra_capabilities_t
*, int);
91 static void zprivs_caps_init(struct zebra_privs_t
*);
92 static void zprivs_caps_terminate(void);
94 /* Map of Quagga abstract capabilities to system capabilities */
97 pvalue_t
*system_caps
;
98 } cap_map
[ZCAP_MAX
] = {
99 #ifdef HAVE_LCAPS /* Quagga -> Linux capabilities mappings */
102 2, (pvalue_t
[]){CAP_SETGID
, CAP_SETUID
},
106 1, (pvalue_t
[]){CAP_NET_BIND_SERVICE
},
110 1, (pvalue_t
[]){CAP_NET_ADMIN
},
114 1, (pvalue_t
[]){CAP_NET_RAW
},
125 1, (pvalue_t
[]){CAP_SYS_NICE
},
129 1, (pvalue_t
[]){CAP_SYS_PTRACE
},
131 [ZCAP_DAC_OVERRIDE
] =
133 1, (pvalue_t
[]){CAP_DAC_OVERRIDE
},
137 1, (pvalue_t
[]){CAP_DAC_READ_SEARCH
},
141 1, (pvalue_t
[]){CAP_SYS_ADMIN
},
145 1, (pvalue_t
[]){CAP_FOWNER
},
149 1, (pvalue_t
[]){CAP_IPC_LOCK
},
153 1, (pvalue_t
[]){CAP_SYS_RAWIO
},
155 #endif /* HAVE_LCAPS */
159 /* Linux forms of capabilities methods */
160 /* convert zebras privileges to system capabilities */
161 static pset_t
*zcaps2sys(zebra_capabilities_t
*zcaps
, int num
)
164 int i
, j
= 0, count
= 0;
169 /* first count up how many system caps we have */
170 for (i
= 0; i
< num
; i
++)
171 count
+= cap_map
[zcaps
[i
]].num
;
173 if ((syscaps
= XCALLOC(MTYPE_PRIVS
, (sizeof(pset_t
) * num
))) == NULL
) {
174 fprintf(stderr
, "%s: could not allocate syscaps!", __func__
);
178 syscaps
->caps
= XCALLOC(MTYPE_PRIVS
, (sizeof(pvalue_t
) * count
));
180 if (!syscaps
->caps
) {
181 fprintf(stderr
, "%s: could not XCALLOC caps!", __func__
);
185 /* copy the capabilities over */
187 for (i
= 0; i
< num
; i
++)
188 for (j
= 0; j
< cap_map
[zcaps
[i
]].num
; j
++)
189 syscaps
->caps
[count
++] =
190 cap_map
[zcaps
[i
]].system_caps
[j
];
192 /* iterations above should be exact same as previous count, obviously..
194 syscaps
->num
= count
;
199 /* set or clear the effective capabilities to/from permitted */
200 int zprivs_change_caps(zebra_privs_ops_t op
)
202 cap_flag_value_t cflag
;
204 /* should be no possibility of being called without valid caps */
205 assert(zprivs_state
.syscaps_p
&& zprivs_state
.caps
);
206 if (!(zprivs_state
.syscaps_p
&& zprivs_state
.caps
))
209 if (op
== ZPRIVS_RAISE
)
211 else if (op
== ZPRIVS_LOWER
)
216 if (!cap_set_flag(zprivs_state
.caps
, CAP_EFFECTIVE
,
217 zprivs_state
.syscaps_p
->num
,
218 zprivs_state
.syscaps_p
->caps
, cflag
))
219 return cap_set_proc(zprivs_state
.caps
);
223 zebra_privs_current_t
zprivs_state_caps(void)
226 cap_flag_value_t val
;
228 /* should be no possibility of being called without valid caps */
229 assert(zprivs_state
.syscaps_p
&& zprivs_state
.caps
);
230 if (!(zprivs_state
.syscaps_p
&& zprivs_state
.caps
))
233 for (i
= 0; i
< zprivs_state
.syscaps_p
->num
; i
++) {
234 if (cap_get_flag(zprivs_state
.caps
,
235 zprivs_state
.syscaps_p
->caps
[i
], CAP_EFFECTIVE
,
239 "zprivs_state_caps: could not cap_get_flag, %s",
240 safe_strerror(errno
));
241 return ZPRIVS_UNKNOWN
;
244 return ZPRIVS_RAISED
;
246 return ZPRIVS_LOWERED
;
249 /** Release private cap state if allocated. */
250 static void zprivs_state_free_caps(void)
252 if (zprivs_state
.syscaps_p
) {
253 if (zprivs_state
.syscaps_p
->num
)
254 XFREE(MTYPE_PRIVS
, zprivs_state
.syscaps_p
->caps
);
256 XFREE(MTYPE_PRIVS
, zprivs_state
.syscaps_p
);
259 if (zprivs_state
.syscaps_i
) {
260 if (zprivs_state
.syscaps_i
->num
)
261 XFREE(MTYPE_PRIVS
, zprivs_state
.syscaps_i
->caps
);
263 XFREE(MTYPE_PRIVS
, zprivs_state
.syscaps_i
);
266 if (zprivs_state
.caps
) {
267 cap_free(zprivs_state
.caps
);
268 zprivs_state
.caps
= NULL
;
272 static void zprivs_caps_init(struct zebra_privs_t
*zprivs
)
274 /* Release allocated zcaps if this function was called before. */
275 zprivs_state_free_caps();
277 zprivs_state
.syscaps_p
= zcaps2sys(zprivs
->caps_p
, zprivs
->cap_num_p
);
278 zprivs_state
.syscaps_i
= zcaps2sys(zprivs
->caps_i
, zprivs
->cap_num_i
);
280 /* Tell kernel we want caps maintained across uid changes */
281 if (prctl(PR_SET_KEEPCAPS
, 1, 0, 0, 0) == -1) {
283 "privs_init: could not set PR_SET_KEEPCAPS, %s\n",
284 safe_strerror(errno
));
288 /* we have caps, we have no need to ever change back the original user
290 /* only change uid if we don't have the correct one */
291 if ((zprivs_state
.zuid
) && (zprivs_state
.zsuid
!= zprivs_state
.zuid
)) {
292 if (setreuid(zprivs_state
.zuid
, zprivs_state
.zuid
)) {
294 "zprivs_init (cap): could not setreuid, %s\n",
295 safe_strerror(errno
));
300 if (!(zprivs_state
.caps
= cap_init())) {
301 fprintf(stderr
, "privs_init: failed to cap_init, %s\n",
302 safe_strerror(errno
));
306 if (cap_clear(zprivs_state
.caps
)) {
307 fprintf(stderr
, "privs_init: failed to cap_clear, %s\n",
308 safe_strerror(errno
));
312 /* set permitted caps, if any */
313 if (zprivs_state
.syscaps_p
&& zprivs_state
.syscaps_p
->num
) {
314 cap_set_flag(zprivs_state
.caps
, CAP_PERMITTED
,
315 zprivs_state
.syscaps_p
->num
,
316 zprivs_state
.syscaps_p
->caps
, CAP_SET
);
319 /* set inheritable caps, if any */
320 if (zprivs_state
.syscaps_i
&& zprivs_state
.syscaps_i
->num
) {
321 cap_set_flag(zprivs_state
.caps
, CAP_INHERITABLE
,
322 zprivs_state
.syscaps_i
->num
,
323 zprivs_state
.syscaps_i
->caps
, CAP_SET
);
326 /* apply caps. CAP_EFFECTIVE is cleared. we'll raise the caps as
327 * and when, and only when, they are needed.
329 if (cap_set_proc(zprivs_state
.caps
)) {
331 char *current_caps_text
= NULL
;
332 char *wanted_caps_text
= NULL
;
334 fprintf(stderr
, "privs_init: initial cap_set_proc failed: %s\n",
335 safe_strerror(errno
));
337 current_caps
= cap_get_proc();
339 current_caps_text
= cap_to_text(current_caps
, NULL
);
340 cap_free(current_caps
);
343 wanted_caps_text
= cap_to_text(zprivs_state
.caps
, NULL
);
344 fprintf(stderr
, "Wanted caps: %s\n",
345 wanted_caps_text
? wanted_caps_text
: "???");
346 fprintf(stderr
, "Have caps: %s\n",
347 current_caps_text
? current_caps_text
: "???");
348 if (current_caps_text
)
349 cap_free(current_caps_text
);
350 if (wanted_caps_text
)
351 cap_free(wanted_caps_text
);
356 /* set methods for the caller to use */
357 zprivs
->change
= zprivs_change_caps
;
358 zprivs
->current_state
= zprivs_state_caps
;
361 static void zprivs_caps_terminate(void)
363 /* Clear all capabilities, if we have any. */
364 if (zprivs_state
.caps
)
365 cap_clear(zprivs_state
.caps
);
369 /* and boom, capabilities are gone forever */
370 if (cap_set_proc(zprivs_state
.caps
)) {
371 fprintf(stderr
, "privs_terminate: cap_set_proc failed, %s",
372 safe_strerror(errno
));
376 zprivs_state_free_caps();
378 #else /* !HAVE_LCAPS */
379 #error "no Linux capabilities, dazed and confused..."
380 #endif /* HAVE_LCAPS */
381 #endif /* HAVE_CAPABILITIES */
383 int zprivs_change_uid(zebra_privs_ops_t op
)
385 if (zprivs_state
.zsuid
== zprivs_state
.zuid
)
387 if (op
== ZPRIVS_RAISE
)
388 return seteuid(zprivs_state
.zsuid
);
389 else if (op
== ZPRIVS_LOWER
)
390 return seteuid(zprivs_state
.zuid
);
395 zebra_privs_current_t
zprivs_state_uid(void)
397 return ((zprivs_state
.zuid
== geteuid()) ? ZPRIVS_LOWERED
401 int zprivs_change_null(zebra_privs_ops_t op
)
406 zebra_privs_current_t
zprivs_state_null(void)
408 return zprivs_null_state
;
411 #ifndef HAVE_GETGROUPLIST
412 /* Solaris 11 has no getgrouplist() */
413 static int getgrouplist(const char *user
, gid_t group
, gid_t
*groups
,
425 while ((grp
= getgrent())) {
426 if (grp
->gr_gid
== group
)
428 for (usridx
= 0; grp
->gr_mem
[usridx
] != NULL
; usridx
++)
429 if (!strcmp(grp
->gr_mem
[usridx
], user
)) {
431 groups
[pos
] = grp
->gr_gid
;
438 ret
= (pos
<= *ngroups
) ? pos
: -1;
442 #endif /* HAVE_GETGROUPLIST */
445 * Helper function that locates a refcounting object to use: a process-wide
446 * object or a per-pthread object.
448 static struct zebra_privs_refs_t
*get_privs_refs(struct zebra_privs_t
*privs
)
450 struct zebra_privs_refs_t
*temp
, *refs
= NULL
;
453 if (privs_per_process
)
454 refs
= &(privs
->process_refs
);
456 /* Locate - or create - the object for the current pthread. */
457 tid
= pthread_self();
459 STAILQ_FOREACH(temp
, &(privs
->thread_refs
), entry
) {
460 if (pthread_equal(temp
->tid
, tid
)) {
466 /* Need to create a new refcounting object. */
468 refs
= XCALLOC(MTYPE_PRIVS
,
469 sizeof(struct zebra_privs_refs_t
));
471 STAILQ_INSERT_TAIL(&(privs
->thread_refs
), refs
, entry
);
478 struct zebra_privs_t
*_zprivs_raise(struct zebra_privs_t
*privs
,
479 const char *funcname
)
481 int save_errno
= errno
;
482 struct zebra_privs_refs_t
*refs
;
488 * Serialize 'raise' operations; particularly important for
489 * OSes where privs are process-wide.
491 frr_with_mutex (&(privs
->mutex
)) {
492 /* Locate ref-counting object to use */
493 refs
= get_privs_refs(privs
);
495 if (++(refs
->refcount
) == 1) {
497 if (privs
->change(ZPRIVS_RAISE
)) {
498 zlog_err("%s: Failed to raise privileges (%s)",
499 funcname
, safe_strerror(errno
));
502 refs
->raised_in_funcname
= funcname
;
509 void _zprivs_lower(struct zebra_privs_t
**privs
)
511 int save_errno
= errno
;
512 struct zebra_privs_refs_t
*refs
;
517 /* Serialize 'lower privs' operation - particularly important
518 * when OS privs are process-wide.
520 frr_with_mutex (&(*privs
)->mutex
) {
521 refs
= get_privs_refs(*privs
);
523 if (--(refs
->refcount
) == 0) {
525 if ((*privs
)->change(ZPRIVS_LOWER
)) {
526 zlog_err("%s: Failed to lower privileges (%s)",
527 refs
->raised_in_funcname
,
528 safe_strerror(errno
));
531 refs
->raised_in_funcname
= NULL
;
538 void zprivs_preinit(struct zebra_privs_t
*zprivs
)
540 struct passwd
*pwentry
= NULL
;
541 struct group
*grentry
= NULL
;
544 fprintf(stderr
, "zprivs_init: called with NULL arg!\n");
548 pthread_mutex_init(&(zprivs
->mutex
), NULL
);
549 zprivs
->process_refs
.refcount
= 0;
550 zprivs
->process_refs
.raised_in_funcname
= NULL
;
551 STAILQ_INIT(&zprivs
->thread_refs
);
553 if (zprivs
->vty_group
) {
554 /* in a "NULL" setup, this is allowed to fail too, but still
556 if ((grentry
= getgrnam(zprivs
->vty_group
)))
557 zprivs_state
.vtygrp
= grentry
->gr_gid
;
559 zprivs_state
.vtygrp
= (gid_t
)-1;
563 if (!(zprivs
->user
|| zprivs
->group
|| zprivs
->cap_num_p
564 || zprivs
->cap_num_i
)) {
565 zprivs
->change
= zprivs_change_null
;
566 zprivs
->current_state
= zprivs_state_null
;
571 if ((pwentry
= getpwnam(zprivs
->user
)) == NULL
) {
572 /* cant use log.h here as it depends on vty */
574 "privs_init: could not lookup user %s\n",
579 zprivs_state
.zuid
= pwentry
->pw_uid
;
580 zprivs_state
.zgid
= pwentry
->pw_gid
;
586 if ((grentry
= getgrnam(zprivs
->group
)) == NULL
) {
588 "privs_init: could not lookup group %s\n",
593 zprivs_state
.zgid
= grentry
->gr_gid
;
597 struct zebra_privs_t
*lib_privs
;
599 void zprivs_init(struct zebra_privs_t
*zprivs
)
601 gid_t groups
[NGROUPS_MAX
] = {};
606 if (!(zprivs
->user
|| zprivs
->group
|| zprivs
->cap_num_p
607 || zprivs
->cap_num_i
))
613 ngroups
= array_size(groups
);
614 if (getgrouplist(zprivs
->user
, zprivs_state
.zgid
, groups
,
617 /* cant use log.h here as it depends on vty */
619 "privs_init: could not getgrouplist for user %s\n",
625 if (zprivs
->vty_group
)
626 /* Add the vty_group to the supplementary groups so it can be chowned to
629 if (zprivs_state
.vtygrp
== (gid_t
)-1) {
631 "privs_init: could not lookup vty group %s\n",
636 for (i
= 0; i
< ngroups
; i
++)
637 if (groups
[i
] == zprivs_state
.vtygrp
) {
644 "privs_init: user(%s) is not part of vty group specified(%s)\n",
645 zprivs
->user
, zprivs
->vty_group
);
648 if (i
>= ngroups
&& ngroups
< (int)array_size(groups
)) {
649 groups
[i
] = zprivs_state
.vtygrp
;
653 zprivs_state
.zsuid
= geteuid(); /* initial uid */
654 /* add groups only if we changed uid - otherwise skip */
655 if ((ngroups
) && (zprivs_state
.zsuid
!= zprivs_state
.zuid
)) {
656 if (setgroups(ngroups
, groups
)) {
657 fprintf(stderr
, "privs_init: could not setgroups, %s\n",
658 safe_strerror(errno
));
663 /* change gid only if we changed uid - otherwise skip */
664 if ((zprivs_state
.zgid
) && (zprivs_state
.zsuid
!= zprivs_state
.zuid
)) {
665 /* change group now, forever. uid we do later */
666 if (setregid(zprivs_state
.zgid
, zprivs_state
.zgid
)) {
667 fprintf(stderr
, "zprivs_init: could not setregid, %s\n",
668 safe_strerror(errno
));
673 #ifdef HAVE_CAPABILITIES
674 zprivs_caps_init(zprivs
);
677 * If we have initialized the system with no requested
678 * capabilities, change will not have been set
679 * to anything by zprivs_caps_init, As such
680 * we should make sure that when we attempt
681 * to raize privileges that we actually have
682 * a do nothing function to call instead of a
686 zprivs
->change
= zprivs_change_null
;
688 #else /* !HAVE_CAPABILITIES */
689 /* we dont have caps. we'll need to maintain rid and saved uid
690 * and change euid back to saved uid (who we presume has all necessary
691 * privileges) whenever we are asked to raise our privileges.
693 * This is not worth that much security wise, but all we can do.
695 zprivs_state
.zsuid
= geteuid();
696 /* only change uid if we don't have the correct one */
697 if ((zprivs_state
.zuid
) && (zprivs_state
.zsuid
!= zprivs_state
.zuid
)) {
698 if (setreuid(-1, zprivs_state
.zuid
)) {
700 "privs_init (uid): could not setreuid, %s\n",
701 safe_strerror(errno
));
706 zprivs
->change
= zprivs_change_uid
;
707 zprivs
->current_state
= zprivs_state_uid
;
708 #endif /* HAVE_CAPABILITIES */
711 void zprivs_terminate(struct zebra_privs_t
*zprivs
)
713 struct zebra_privs_refs_t
*refs
;
718 fprintf(stderr
, "%s: no privs struct given, terminating",
723 #ifdef HAVE_CAPABILITIES
724 if (zprivs
->user
|| zprivs
->group
|| zprivs
->cap_num_p
725 || zprivs
->cap_num_i
)
726 zprivs_caps_terminate();
727 #else /* !HAVE_CAPABILITIES */
728 /* only change uid if we don't have the correct one */
729 if ((zprivs_state
.zuid
) && (zprivs_state
.zsuid
!= zprivs_state
.zuid
)) {
730 if (setreuid(zprivs_state
.zuid
, zprivs_state
.zuid
)) {
732 "privs_terminate: could not setreuid, %s",
733 safe_strerror(errno
));
737 #endif /* HAVE_LCAPS */
739 while ((refs
= STAILQ_FIRST(&(zprivs
->thread_refs
))) != NULL
) {
740 STAILQ_REMOVE_HEAD(&(zprivs
->thread_refs
), entry
);
741 XFREE(MTYPE_PRIVS
, refs
);
744 zprivs
->change
= zprivs_change_null
;
745 zprivs
->current_state
= zprivs_state_null
;
746 zprivs_null_state
= ZPRIVS_LOWERED
;
750 void zprivs_get_ids(struct zprivs_ids_t
*ids
)
753 ids
->uid_priv
= getuid();
754 (zprivs_state
.zuid
) ? (ids
->uid_normal
= zprivs_state
.zuid
)
755 : (ids
->uid_normal
= (uid_t
)-1);
756 (zprivs_state
.zgid
) ? (ids
->gid_normal
= zprivs_state
.zgid
)
757 : (ids
->gid_normal
= (uid_t
)-1);
758 (zprivs_state
.vtygrp
) ? (ids
->gid_vty
= zprivs_state
.vtygrp
)
759 : (ids
->gid_vty
= (uid_t
)-1);