[image] Redact password from URIs displayed by imgfetch()
[people/lynusvaz/gpxe.git] / src / usr / imgmgmt.c
1 /*
2  * Copyright (C) 2007 Michael Brown <mbrown@fensystems.co.uk>.
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License as
6  * published by the Free Software Foundation; either version 2 of the
7  * License, or any later version.
8  *
9  * This program is distributed in the hope that it will be useful, but
10  * WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12  * General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software
16  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
17  */
18
19 #include <stdint.h>
20 #include <stdlib.h>
21 #include <stdio.h>
22 #include <errno.h>
23 #include <gpxe/image.h>
24 #include <gpxe/downloader.h>
25 #include <gpxe/monojob.h>
26 #include <gpxe/open.h>
27 #include <gpxe/uri.h>
28 #include <usr/imgmgmt.h>
29
30 /** @file
31  *
32  * Image management
33  *
34  */
35
36 /**
37  * Fetch an image
38  *
39  * @v uri_string        URI as a string (e.g. "http://www.nowhere.com/vmlinuz")
40  * @v name              Name for image, or NULL
41  * @v register_image    Image registration routine
42  * @ret rc              Return status code
43  */
44 int imgfetch ( struct image *image, const char *uri_string,
45                int ( * image_register ) ( struct image *image ) ) {
46         char uri_string_redacted[ strlen ( uri_string ) + 3 /* "***" */
47                                   + 1 /* NUL */ ];
48         struct uri *uri;
49         const char *password;
50         int rc;
51
52         if ( ! ( uri = parse_uri ( uri_string ) ) )
53                 return -ENOMEM;
54
55         image_set_uri ( image, uri );
56
57         /* Redact password portion of URI, if necessary */
58         password = uri->password;
59         if ( password )
60                 uri->password = "***";
61         unparse_uri ( uri_string_redacted, sizeof ( uri_string_redacted ),
62                       uri );
63         uri->password = password;
64
65         if ( ( rc = create_downloader ( &monojob, image, image_register,
66                                         LOCATION_URI, uri ) ) == 0 )
67                 rc = monojob_wait ( uri_string_redacted );
68
69         uri_put ( uri );
70         return rc;
71 }
72
73 /**
74  * Load an image
75  *
76  * @v image             Image
77  * @ret rc              Return status code
78  */
79 int imgload ( struct image *image ) {
80         int rc;
81
82         /* Try to load image */
83         if ( ( rc = image_autoload ( image ) ) != 0 )
84                 return rc;
85
86         return 0;
87 }
88
89 /**
90  * Execute an image
91  *
92  * @v image             Image
93  * @ret rc              Return status code
94  */
95 int imgexec ( struct image *image ) {
96         return image_exec ( image );
97 }
98
99 /**
100  * Identify the only loaded image
101  *
102  * @ret image           Image, or NULL if 0 or >1 images are loaded
103  */
104 struct image * imgautoselect ( void ) {
105         struct image *image;
106         struct image *selected_image = NULL;
107         int flagged_images = 0;
108
109         for_each_image ( image ) {
110                 if ( image->flags & IMAGE_LOADED ) {
111                         selected_image = image;
112                         flagged_images++;
113                 }
114         }
115
116         return ( ( flagged_images == 1 ) ? selected_image : NULL );
117 }
118
119 /**
120  * Display status of an image
121  *
122  * @v image             Executable/loadable image
123  */
124 void imgstat ( struct image *image ) {
125         printf ( "%s: %zd bytes", image->name, image->len );
126         if ( image->type )
127                 printf ( " [%s]", image->type->name );
128         if ( image->flags & IMAGE_LOADED )
129                 printf ( " [LOADED]" );
130         if ( image->cmdline )
131                 printf ( " \"%s\"", image->cmdline );
132         printf ( "\n" );
133 }
134
135 /**
136  * Free an image
137  *
138  * @v image             Executable/loadable image
139  */
140 void imgfree ( struct image *image ) {
141         unregister_image ( image );
142 }