1 '\" te
2 .\" Copyright (c) 2009, Sun Microsystems, Inc. All Rights Reserved.
3 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.
4 .\" See the License for the specific language governing permissions and limitations under the License. When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with
5 .\" the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
6 .TH SMF_METHOD 5 "May 20, 2009"
7 .SH NAME
8 smf_method \- service management framework conventions for methods
9 .SH DESCRIPTION
10 .sp
11 .LP
12 The class of services managed by \fBsvc.startd\fR(1M) in the service management
13 framework, \fBsmf\fR(5), consists of applications that fit a simple
14 \fBfork\fR(2)-\fBexec\fR(2) model. The \fBsvc.startd\fR(1M) master daemon and
15 other restarters support the \fBfork\fR(2)-\fBexec\fR(2) model, potentially
16 with additional capabilities. The \fBsvc.startd\fR(1M) daemon and other
17 restarters require that the methods which activate, manipulate, or examine a
18 service instance follow the conventions described in this manual page.
19 .SS "Invocation form"
20 .sp
21 .LP
22 The form of a method invocation is not dictated by convention. In some cases, a
23 method invocation might consist of the direct invocation of the daemon or other
24 binary executable that provides the service. For cases in which an executable
25 script or other mediating executable is used, the convention recommends the
26 form:
27 .sp
28 .in +2
29 .nf
30 /path/to/method_executable abbr_method_name
31 .fi
32 .in -2
33
34 .sp
35 .LP
36 The \fIabbr_method_name\fR used for the recommended form is a supported method
37 such as \fBstart\fR or \fBstop\fR. The set of methods supported by a restarter
38 is given on the related restarter page. The \fBsvc.startd\fR(1M) daemon
39 supports \fBstart\fR, \fBstop\fR, and \fBrefresh\fR methods.
40 .sp
41 .LP
42 A restarter might define other kinds of methods beyond those referenced in this
43 page. The conventions surrounding such extensions are defined by the restarter
44 and might not be identical to those given here.
45 .SS "Environment Variables"
46 .sp
47 .LP
48 The restarter provides four environment variables to the method that determine
49 the context in which the method is invoked.
50 .sp
51 .ne 2
52 .na
53 \fB\fBSMF_FMRI\fR\fR
54 .ad
55 .sp .6
56 .RS 4n
57 The service fault management resource identifier (FMRI) of the instance for
58 which the method is invoked.
59 .RE
60
61 .sp
62 .ne 2
63 .na
64 \fB\fBSMF_METHOD\fR\fR
65 .ad
66 .sp .6
83 .na
84 \fB\fBSMF_ZONENAME\fR\fR
85 .ad
86 .sp .6
87 .RS 4n
88 The name of the zone in which the method is running. This can also be obtained
89 by using the \fBzonename\fR(1) command.
90 .RE
91
92 .sp
93 .LP
94 These variables should be removed from the environment prior to the invocation
95 of any persistent process by the method. A convenience shell function,
96 \fBsmf_clear_env\fR, is given for service authors who use Bourne-compatible
97 shell scripting to compose service methods in the include file described below.
98 .sp
99 .LP
100 The method context can cause other environment variables to be set as described
101 below.
102 .SS "Method Definition"
103 .sp
104 .LP
105 A method is defined minimally by three properties in a propertygroup of type
106 \fBmethod\fR.
107 .sp
108 .LP
109 These properties are:
110 .sp
111 .ne 2
112 .na
113 \fBexec (\fIastring\fR)\fR
114 .ad
115 .RS 27n
116 Method executable string.
117 .RE
118
119 .sp
120 .ne 2
121 .na
122 \fBtimeout_seconds (\fIcount\fR)\fR
123 .ad
124 .RS 27n
125 Number of seconds before method times out. See the \fBTimeouts\fR section for
126 more detail.
127 .RE
128
129 .sp
130 .ne 2
131 .na
132 \fBtype (\fIastring\fR)\fR
133 .ad
134 .RS 27n
135 Method type. Currently always set to \fBmethod\fR.
136 .RE
137
138 .sp
139 .LP
140 A Method Context can be defined to further refine the execution environment of
141 the method. See the \fBMethod Context\fR section for more information.
142 .SS "Method Tokens"
143 .sp
144 .LP
145 When defined in the \fBexec\fR string of the method by the restarter
146 \fBsvc.startd\fR, a set of tokens are parsed and expanded with appropriate
147 value. Other restarters might not support method tokens. The delegated
148 restarter for inet services, \fBinetd\fR(1M), does not support the following
149 method expansions.
150 .sp
151 .ne 2
152 .na
153 \fB\fB%%\fR\fR
154 .ad
155 .sp .6
156 .RS 4n
157 %
158 .RE
159
160 .sp
161 .ne 2
162 .na
163 \fB\fB%r\fR\fR
241 .sp .6
242 .RS 4n
243 Sends the specified signal, which is \fBSIGTERM\fR by default, to all processes
244 in the primary instance contract. Always returns \fBSMF_EXIT_OK\fR. This token
245 should be used to replace common \fBpkill\fR invocations.
246 .RE
247
248 .sp
249 .ne 2
250 .na
251 \fB\fB:true\fR\fR
252 .ad
253 .sp .6
254 .RS 4n
255 Always returns \fBSMF_EXIT_OK\fR. This token should be used for methods that
256 are required by the restarter but which are unnecessary for the particular
257 service implementation.
258 .RE
259
260 .SS "Exiting and Exit Status"
261 .sp
262 .LP
263 The required behavior of a start method is to delay exiting until the service
264 instance is ready to answer requests or is otherwise functional.
265 .sp
266 .LP
267 The following exit status codes are defined in \fB<libscf.h>\fR and in the
268 shell support file.
269 .sp
270
271 .sp
272 .TS
273 l l l
274 l l l .
275 \fBSMF_EXIT_OK\fR \fB0\fR T{
276 Method exited, performing its operation successfully.
277 T}
278 \fBSMF_EXIT_ERR_FATAL\fR \fB95\fR T{
279 Method failed fatally and is unrecoverable without administrative intervention.
280 T}
281 \fBSMF_EXIT_ERR_CONFIG\fR \fB96\fR T{
282 Unrecoverable configuration error. A common condition that returns this exit status is the absence of required configuration files for an enabled service instance.
283 T}
284 \fBSMF_EXIT_ERR_NOSMF\fR \fB99\fR T{
285 Method has been mistakenly invoked outside the \fBsmf\fR(5) facility. Services that depend on \fBsmf\fR(5) capabilities should exit with this status value.
286 T}
287 \fBSMF_EXIT_ERR_PERM\fR \fB100\fR T{
288 Method requires a form of permission such as file access, privilege, authorization, or other credential that is not available when invoked.
289 T}
290 \fBSMF_EXIT_ERR_OTHER\fR \fBnon-zero\fR T{
291 Any non-zero exit status from a method is treated as an unknown error. A series of unknown errors can be diagnosed as a fault by the restarter or on behalf of the restarter.
292 T}
293 .TE
294
295 .sp
296 .LP
297 Use of a precise exit code allows the responsible restarter to categorize an
298 error response as likely to be intermittent and worth pursuing restart or
299 permanent and request administrative intervention.
300 .SS "Timeouts"
301 .sp
302 .LP
303 Each method can have an independent timeout, given in seconds. The choice of a
304 particular timeout should be based on site expectations for detecting a method
305 failure due to non-responsiveness. Sites with replicated filesystems or other
306 failover resources can elect to lengthen method timeouts from the default.
307 Sites with no remote resources can elect to shorten the timeouts. Method
308 timeout is specified by the \fBtimeout_seconds\fR property.
309 .sp
310 .LP
311 If you specify \fB0 timeout_seconds\fR for a method, it declares to the
312 restarter that there is no timeout for the service. This setting is not
313 preferred, but is available for services that absolutely require it.
314 .sp
315 .LP
316 \fB-1 timeout_seconds\fR is also accepted, but is a deprecated specification.
317 .SS "Shell Programming Support"
318 .sp
319 .LP
320 A set of environment variables that define the above exit status values is
321 provided with convenience shell functions in the file
322 \fB/lib/svc/share/smf_include.sh\fR. This file is a Bourne shell script
323 suitable for inclusion via the source operator in any Bourne-compatible shell.
324 .sp
325 .LP
326 To assist in the composition of scripts that can serve as SMF methods as well
327 as \fB/etc/init.d\fR scripts, the \fBsmf_present()\fR shell function is
328 provided. If the \fBsmf\fR(5) facility is not available, \fBsmf_present()\fR
329 returns a non-zero exit status.
330 .sp
331 .LP
332 One possible structure for such a script follows:
333 .sp
334 .in +2
335 .nf
336 if smf_present; then
337 # Shell code to run application as managed service
338 ....
339
340 smf_clear_env
341 else
342 # Shell code to run application as /etc/init.d script
343 ....
344 fi
345 .fi
346 .in -2
347
348 .sp
349 .LP
350 This example shows the use of both convenience functions that are provided.
351 .SS "Method Context"
352 .sp
353 .LP
354 The service management facility offers a common mechanism set the context in
355 which the \fBfork\fR(2)-\fBexec\fR(2) model services execute.
356 .sp
357 .LP
358 The desired method context should be provided by the service developer. All
359 service instances should run with the lowest level of privileges possible to
360 limit potential security compromises.
361 .sp
362 .LP
363 A method context can contain the following properties:
364 .sp
365 .ne 2
366 .na
367 \fB\fBuse_profile\fR\fR
368 .ad
369 .sp .6
370 .RS 4n
371 A boolean that specifies whether the profile should be used instead of the
372 \fBuser\fR, \fBgroup\fR, \fBprivileges\fR, and \fBlimit_privileges\fR
446 .RS 4n
447 An optional string specifying the limit privilege set as defined in
448 \fBprivileges\fR(5).
449 .RE
450
451 .sp
452 .ne 2
453 .na
454 \fB\fBworking_directory\fR\fR
455 .ad
456 .sp .6
457 .RS 4n
458 The home directory from which to launch the method. \fB:home\fR can be used as
459 a token to indicate the home directory of the user whose \fBuid\fR is used to
460 launch the method. If the property is unset, \fB:home\fR is used.
461 .RE
462
463 .sp
464 .ne 2
465 .na
466 \fB\fBcorefile_pattern\fR\fR
467 .ad
468 .sp .6
469 .RS 4n
470 An optional string that specifies the corefile pattern to use for the service,
471 as per \fBcoreadm\fR(1M). Most restarters supply a default. Setting this
472 property overrides local customizations to the global core pattern.
473 .RE
474
475 .sp
476 .ne 2
477 .na
478 \fB\fBproject\fR\fR
479 .ad
480 .sp .6
481 .RS 4n
482 The project ID in numeric or text form. \fB:default\fR can be used as a token
483 to indicate a project identified by \fBgetdefaultproj\fR(3PROJECT) for the user
484 whose \fBuid\fR is used to launch the method.
485 .RE
517 \fBArgument array\fR
518 .ad
519 .sp .6
520 .RS 4n
521 The arguments in \fBargv[]\fR are set consistently with the result \fB/bin/sh
522 -c\fR of the \fBexec\fR string.
523 .RE
524
525 .sp
526 .ne 2
527 .na
528 \fBFile descriptors\fR
529 .ad
530 .sp .6
531 .RS 4n
532 File descriptor \fB0\fR is \fB/dev/null\fR. File descriptors \fB1\fR and
533 \fB2\fR are recommended to be a per-service log file.
534 .RE
535
536 .SH FILES
537 .sp
538 .ne 2
539 .na
540 \fB\fB/lib/svc/share/smf_include.sh\fR\fR
541 .ad
542 .sp .6
543 .RS 4n
544 Definitions of exit status values.
545 .RE
546
547 .sp
548 .ne 2
549 .na
550 \fB\fB/usr/include/libscf.h\fR\fR
551 .ad
552 .sp .6
553 .RS 4n
554 Definitions of exit status codes.
555 .RE
556
557 .SH SEE ALSO
558 .sp
559 .LP
560 \fBzonename\fR(1), \fBcoreadm\fR(1M), \fBinetd\fR(1M), \fBsvccfg\fR(1M),
561 \fBsvc.startd\fR(1M), \fBexec\fR(2), \fBfork\fR(2),
562 \fBgetdefaultproj\fR(3PROJECT), \fBexec_attr\fR(4), \fBproject\fR(4),
563 \fBservice_bundle\fR(4), \fBattributes\fR(5), \fBprivileges\fR(5),
564 \fBrbac\fR(5), \fBsmf\fR(5), \fBsmf_bootstrap\fR(5), \fBzones\fR(5)
565 .SH NOTES
566 .sp
567 .LP
568 The present version of \fBsmf\fR(5) does not support multiple repositories.
569 .sp
570 .LP
571 When a service is configured to be started as root but with privileges
572 different from \fBlimit_privileges\fR, the resulting process is privilege
573 aware. This can be surprising to developers who expect \fBseteuid(<non-zero
574 UID>)\fR to reduce privileges to basic or less.
|
1 '\" te
2 .\" Copyright (c) 2009, Sun Microsystems, Inc. All Rights Reserved.
3 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.
4 .\" See the License for the specific language governing permissions and limitations under the License. When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with
5 .\" the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
6 .TH SMF_METHOD 5 "May 20, 2009"
7 .SH NAME
8 smf_method \- service management framework conventions for methods
9 .SH DESCRIPTION
10 .LP
11 The class of services managed by \fBsvc.startd\fR(1M) in the service management
12 framework, \fBsmf\fR(5), consists of applications that fit a simple
13 \fBfork\fR(2)-\fBexec\fR(2) model. The \fBsvc.startd\fR(1M) master daemon and
14 other restarters support the \fBfork\fR(2)-\fBexec\fR(2) model, potentially
15 with additional capabilities. The \fBsvc.startd\fR(1M) daemon and other
16 restarters require that the methods which activate, manipulate, or examine a
17 service instance follow the conventions described in this manual page.
18 .SS "Invocation form"
19 .LP
20 The form of a method invocation is not dictated by convention. In some cases, a
21 method invocation might consist of the direct invocation of the daemon or other
22 binary executable that provides the service. For cases in which an executable
23 script or other mediating executable is used, the convention recommends the
24 form:
25 .sp
26 .in +2
27 .nf
28 /path/to/method_executable abbr_method_name
29 .fi
30 .in -2
31
32 .sp
33 .LP
34 The \fIabbr_method_name\fR used for the recommended form is a supported method
35 such as \fBstart\fR or \fBstop\fR. The set of methods supported by a restarter
36 is given on the related restarter page. The \fBsvc.startd\fR(1M) daemon
37 supports \fBstart\fR, \fBstop\fR, and \fBrefresh\fR methods.
38 .sp
39 .LP
40 A restarter might define other kinds of methods beyond those referenced in this
41 page. The conventions surrounding such extensions are defined by the restarter
42 and might not be identical to those given here.
43 .SS "Environment Variables"
44 .LP
45 The restarter provides four environment variables to the method that determine
46 the context in which the method is invoked.
47 .sp
48 .ne 2
49 .na
50 \fB\fBSMF_FMRI\fR\fR
51 .ad
52 .sp .6
53 .RS 4n
54 The service fault management resource identifier (FMRI) of the instance for
55 which the method is invoked.
56 .RE
57
58 .sp
59 .ne 2
60 .na
61 \fB\fBSMF_METHOD\fR\fR
62 .ad
63 .sp .6
80 .na
81 \fB\fBSMF_ZONENAME\fR\fR
82 .ad
83 .sp .6
84 .RS 4n
85 The name of the zone in which the method is running. This can also be obtained
86 by using the \fBzonename\fR(1) command.
87 .RE
88
89 .sp
90 .LP
91 These variables should be removed from the environment prior to the invocation
92 of any persistent process by the method. A convenience shell function,
93 \fBsmf_clear_env\fR, is given for service authors who use Bourne-compatible
94 shell scripting to compose service methods in the include file described below.
95 .sp
96 .LP
97 The method context can cause other environment variables to be set as described
98 below.
99 .SS "Method Definition"
100 .LP
101 A method is defined minimally by three properties in a propertygroup of type
102 \fBmethod\fR.
103 .sp
104 .LP
105 These properties are:
106 .sp
107 .ne 2
108 .na
109 \fBexec (\fIastring\fR)\fR
110 .ad
111 .RS 27n
112 Method executable string.
113 .RE
114
115 .sp
116 .ne 2
117 .na
118 \fBtimeout_seconds (\fIcount\fR)\fR
119 .ad
120 .RS 27n
121 Number of seconds before method times out. See the \fBTimeouts\fR section for
122 more detail.
123 .RE
124
125 .sp
126 .ne 2
127 .na
128 \fBtype (\fIastring\fR)\fR
129 .ad
130 .RS 27n
131 Method type. Currently always set to \fBmethod\fR.
132 .RE
133
134 .sp
135 .LP
136 A Method Context can be defined to further refine the execution environment of
137 the method. See the \fBMethod Context\fR section for more information.
138 .SS "Method Tokens"
139 .LP
140 When defined in the \fBexec\fR string of the method by the restarter
141 \fBsvc.startd\fR, a set of tokens are parsed and expanded with appropriate
142 value. Other restarters might not support method tokens. The delegated
143 restarter for inet services, \fBinetd\fR(1M), does not support the following
144 method expansions.
145 .sp
146 .ne 2
147 .na
148 \fB\fB%%\fR\fR
149 .ad
150 .sp .6
151 .RS 4n
152 %
153 .RE
154
155 .sp
156 .ne 2
157 .na
158 \fB\fB%r\fR\fR
236 .sp .6
237 .RS 4n
238 Sends the specified signal, which is \fBSIGTERM\fR by default, to all processes
239 in the primary instance contract. Always returns \fBSMF_EXIT_OK\fR. This token
240 should be used to replace common \fBpkill\fR invocations.
241 .RE
242
243 .sp
244 .ne 2
245 .na
246 \fB\fB:true\fR\fR
247 .ad
248 .sp .6
249 .RS 4n
250 Always returns \fBSMF_EXIT_OK\fR. This token should be used for methods that
251 are required by the restarter but which are unnecessary for the particular
252 service implementation.
253 .RE
254
255 .SS "Exiting and Exit Status"
256 .LP
257 The required behavior of a start method is to delay exiting until the service
258 instance is ready to answer requests or is otherwise functional.
259 .sp
260 .LP
261 The following exit status codes are defined in \fB<libscf.h>\fR and in the
262 shell support file.
263 .sp
264
265 .sp
266 .TS
267 l l l
268 l l l .
269 \fBSMF_EXIT_OK\fR \fB0\fR T{
270 Method exited, performing its operation successfully.
271 T}
272 \fBSMF_EXIT_ERR_FATAL\fR \fB95\fR T{
273 Method failed fatally and is unrecoverable without administrative intervention.
274 T}
275 \fBSMF_EXIT_ERR_CONFIG\fR \fB96\fR T{
276 Unrecoverable configuration error. A common condition that returns this exit status is the absence of required configuration files for an enabled service instance.
277 T}
278 \fBSMF_EXIT_ERR_NOSMF\fR \fB99\fR T{
279 Method has been mistakenly invoked outside the \fBsmf\fR(5) facility. Services that depend on \fBsmf\fR(5) capabilities should exit with this status value.
280 T}
281 \fBSMF_EXIT_ERR_PERM\fR \fB100\fR T{
282 Method requires a form of permission such as file access, privilege, authorization, or other credential that is not available when invoked.
283 T}
284 \fBSMF_EXIT_ERR_OTHER\fR \fBnon-zero\fR T{
285 Any non-zero exit status from a method is treated as an unknown error. A series of unknown errors can be diagnosed as a fault by the restarter or on behalf of the restarter.
286 T}
287 .TE
288
289 .sp
290 .LP
291 Use of a precise exit code allows the responsible restarter to categorize an
292 error response as likely to be intermittent and worth pursuing restart or
293 permanent and request administrative intervention.
294 .SS "Timeouts"
295 .LP
296 Each method can have an independent timeout, given in seconds. The choice of a
297 particular timeout should be based on site expectations for detecting a method
298 failure due to non-responsiveness. Sites with replicated filesystems or other
299 failover resources can elect to lengthen method timeouts from the default.
300 Sites with no remote resources can elect to shorten the timeouts. Method
301 timeout is specified by the \fBtimeout_seconds\fR property.
302 .sp
303 .LP
304 If you specify \fB0 timeout_seconds\fR for a method, it declares to the
305 restarter that there is no timeout for the service. This setting is not
306 preferred, but is available for services that absolutely require it.
307 .sp
308 .LP
309 \fB-1 timeout_seconds\fR is also accepted, but is a deprecated specification.
310 .SS "Shell Programming Support"
311 .LP
312 A set of environment variables that define the above exit status values is
313 provided with convenience shell functions in the file
314 \fB/lib/svc/share/smf_include.sh\fR. This file is a Bourne shell script
315 suitable for inclusion via the source operator in any Bourne-compatible shell.
316 .sp
317 .LP
318 To assist in the composition of scripts that can serve as SMF methods as well
319 as \fB/etc/init.d\fR scripts, the \fBsmf_present()\fR shell function is
320 provided. If the \fBsmf\fR(5) facility is not available, \fBsmf_present()\fR
321 returns a non-zero exit status.
322 .sp
323 .LP
324 One possible structure for such a script follows:
325 .sp
326 .in +2
327 .nf
328 if smf_present; then
329 # Shell code to run application as managed service
330 ....
331
332 smf_clear_env
333 else
334 # Shell code to run application as /etc/init.d script
335 ....
336 fi
337 .fi
338 .in -2
339
340 .sp
341 .LP
342 This example shows the use of both convenience functions that are provided.
343 .SS "Method Context"
344 .LP
345 The service management facility offers a common mechanism set the context in
346 which the \fBfork\fR(2)-\fBexec\fR(2) model services execute.
347 .sp
348 .LP
349 The desired method context should be provided by the service developer. All
350 service instances should run with the lowest level of privileges possible to
351 limit potential security compromises.
352 .sp
353 .LP
354 A method context can contain the following properties:
355 .sp
356 .ne 2
357 .na
358 \fB\fBuse_profile\fR\fR
359 .ad
360 .sp .6
361 .RS 4n
362 A boolean that specifies whether the profile should be used instead of the
363 \fBuser\fR, \fBgroup\fR, \fBprivileges\fR, and \fBlimit_privileges\fR
437 .RS 4n
438 An optional string specifying the limit privilege set as defined in
439 \fBprivileges\fR(5).
440 .RE
441
442 .sp
443 .ne 2
444 .na
445 \fB\fBworking_directory\fR\fR
446 .ad
447 .sp .6
448 .RS 4n
449 The home directory from which to launch the method. \fB:home\fR can be used as
450 a token to indicate the home directory of the user whose \fBuid\fR is used to
451 launch the method. If the property is unset, \fB:home\fR is used.
452 .RE
453
454 .sp
455 .ne 2
456 .na
457 \fB\fBsecurity_flags\fR\fR
458 .ad
459 .sp .6
460 .RS 4n
461 The security flags to apply when launching the method. See \fBsecurity-flags\fR(5).
462 .sp
463 .LP
464 The "default" keyword specifies those flags specified in
465 \fBsvc:/system/process-security\fR. The "all" keyword enables all flags, the
466 "none" keyword enables no flags. Further flags may be added by specifying
467 their name, or removed by specifying their name prefixed by '-' or '!'.
468 .sp
469 .LP
470 Use of "all" has associated risks, as future versions of the system may
471 include further flags which may harm poorly implemented software.
472 .RE
473
474 .sp
475 .ne 2
476 .na
477 \fB\fBcorefile_pattern\fR\fR
478 .ad
479 .sp .6
480 .RS 4n
481 An optional string that specifies the corefile pattern to use for the service,
482 as per \fBcoreadm\fR(1M). Most restarters supply a default. Setting this
483 property overrides local customizations to the global core pattern.
484 .RE
485
486 .sp
487 .ne 2
488 .na
489 \fB\fBproject\fR\fR
490 .ad
491 .sp .6
492 .RS 4n
493 The project ID in numeric or text form. \fB:default\fR can be used as a token
494 to indicate a project identified by \fBgetdefaultproj\fR(3PROJECT) for the user
495 whose \fBuid\fR is used to launch the method.
496 .RE
528 \fBArgument array\fR
529 .ad
530 .sp .6
531 .RS 4n
532 The arguments in \fBargv[]\fR are set consistently with the result \fB/bin/sh
533 -c\fR of the \fBexec\fR string.
534 .RE
535
536 .sp
537 .ne 2
538 .na
539 \fBFile descriptors\fR
540 .ad
541 .sp .6
542 .RS 4n
543 File descriptor \fB0\fR is \fB/dev/null\fR. File descriptors \fB1\fR and
544 \fB2\fR are recommended to be a per-service log file.
545 .RE
546
547 .SH FILES
548 .ne 2
549 .na
550 \fB\fB/lib/svc/share/smf_include.sh\fR\fR
551 .ad
552 .sp .6
553 .RS 4n
554 Definitions of exit status values.
555 .RE
556
557 .sp
558 .ne 2
559 .na
560 \fB\fB/usr/include/libscf.h\fR\fR
561 .ad
562 .sp .6
563 .RS 4n
564 Definitions of exit status codes.
565 .RE
566
567 .SH SEE ALSO
568 .LP
569 \fBzonename\fR(1), \fBcoreadm\fR(1M), \fBinetd\fR(1M), \fBsvccfg\fR(1M),
570 \fBsvc.startd\fR(1M), \fBexec\fR(2), \fBfork\fR(2),
571 \fBgetdefaultproj\fR(3PROJECT), \fBexec_attr\fR(4), \fBproject\fR(4),
572 \fBservice_bundle\fR(4), \fBattributes\fR(5), \fBprivileges\fR(5),
573 \fBrbac\fR(5), \fBsmf\fR(5), \fBsmf_bootstrap\fR(5), \fBzones\fR(5),
574 \fBsecurity-flags\fR(5)
575 .SH NOTES
576 .LP
577 The present version of \fBsmf\fR(5) does not support multiple repositories.
578 .sp
579 .LP
580 When a service is configured to be started as root but with privileges
581 different from \fBlimit_privileges\fR, the resulting process is privilege
582 aware. This can be surprising to developers who expect \fBseteuid(<non-zero
583 UID>)\fR to reduce privileges to basic or less.
|