1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
|
/*
* status.go - File which contains the functions for outputting the status of
* fscrypt, a filesystem, or a directory.
*
* Copyright 2017 Google Inc.
* Author: Joe Richey (joerichey@google.com)
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
package main
import (
"fmt"
"io"
"log"
"strings"
"text/tabwriter"
"github.com/pkg/errors"
"github.com/google/fscrypt/actions"
"github.com/google/fscrypt/filesystem"
"github.com/google/fscrypt/keyring"
"github.com/google/fscrypt/metadata"
)
// Creates a writer which correctly aligns tabs with the specified header.
// Must call Flush() when done.
func makeTableWriter(w io.Writer, header string) *tabwriter.Writer {
tableWriter := tabwriter.NewWriter(w, 0, indentLength, indentLength, ' ', 0)
fmt.Fprintln(tableWriter, header)
return tableWriter
}
// encryptionStatus will be printed in the ENCRYPTION column. An empty string
// indicates the filesystem should not be printed.
func encryptionStatus(err error) string {
switch errors.Cause(err) {
case nil:
return "supported"
case metadata.ErrEncryptionNotEnabled:
return "not enabled"
case metadata.ErrEncryptionNotSupported:
return "not supported"
default:
// Unknown error regarding support
return ""
}
}
func yesNoString(b bool) string {
if b {
return "Yes"
}
return "No"
}
func policyUnlockedStatus(policy *actions.Policy) string {
switch policy.GetProvisioningStatus() {
case keyring.KeyPresent:
return "Yes"
case keyring.KeyAbsent:
return "No"
case keyring.KeyAbsentButFilesBusy:
return "Partially (incompletely locked)"
default:
return "Unknown"
}
}
// writeGlobalStatus prints all the filesystems that use (or could use) fscrypt.
func writeGlobalStatus(w io.Writer) error {
mounts, err := filesystem.AllFilesystems()
if err != nil {
return err
}
supportCount := 0
useCount := 0
t := makeTableWriter(w, "MOUNTPOINT\tDEVICE\tFILESYSTEM\tENCRYPTION\tFSCRYPT")
for _, mount := range mounts {
// Only print mountpoints backed by devices or using fscrypt.
usingFscrypt := mount.CheckSetup() == nil
if !usingFscrypt && mount.Device == "" {
continue
}
// Only print a mountpoint if we can determine its support.
supportErr := mount.CheckSupport()
supportString := encryptionStatus(supportErr)
if supportString == "" {
log.Print(supportErr)
continue
}
fmt.Fprintf(t, "%s\t%s\t%s\t%s\t%s\n", mount.Path, mount.Device,
mount.FilesystemType, supportString, yesNoString(usingFscrypt))
if supportErr == nil {
supportCount++
}
if usingFscrypt {
useCount++
}
}
fmt.Fprintf(w, "filesystems supporting encryption: %d\n", supportCount)
fmt.Fprintf(w, "filesystems with fscrypt metadata: %d\n\n", useCount)
return t.Flush()
}
// writeOptions writes a table of the status for a slice of protector options.
func writeOptions(w io.Writer, options []*actions.ProtectorOption) {
t := makeTableWriter(w, "PROTECTOR\tLINKED\tDESCRIPTION")
for _, option := range options {
if option.LoadError != nil {
fmt.Fprintf(t, "%s\t\t[%s]\n", option.Descriptor(), option.LoadError)
continue
}
// For linked protectors, indicate which filesystem.
isLinked := option.LinkedMount != nil
linkedText := yesNoString(isLinked)
if isLinked {
linkedText += fmt.Sprintf(" (%s)", option.LinkedMount.Path)
}
fmt.Fprintf(t, "%s\t%s\t%s\n", option.Descriptor(), linkedText,
formatInfo(option.ProtectorInfo))
}
t.Flush()
}
func writeFilesystemStatus(w io.Writer, ctx *actions.Context) error {
options, err := ctx.ProtectorOptions()
if err != nil {
return err
}
policyDescriptors, err := ctx.Mount.ListPolicies()
if err != nil {
return err
}
fmt.Fprintf(w, "%s filesystem %q has %s and %s\n\n", ctx.Mount.FilesystemType,
ctx.Mount.Path, pluralize(len(options), "protector"),
pluralize(len(policyDescriptors), "policy"))
if len(options) > 0 {
writeOptions(w, options)
}
if len(policyDescriptors) == 0 {
return nil
}
fmt.Fprintln(w)
t := makeTableWriter(w, "POLICY\tUNLOCKED\tPROTECTORS")
for _, descriptor := range policyDescriptors {
policy, err := actions.GetPolicy(ctx, descriptor)
if err != nil {
fmt.Fprintf(t, "%s\t\t[%s]\n", descriptor, err)
continue
}
fmt.Fprintf(t, "%s\t%s\t%s\n", descriptor, policyUnlockedStatus(policy),
strings.Join(policy.ProtectorDescriptors(), ", "))
}
return t.Flush()
}
func writePathStatus(w io.Writer, path string) error {
ctx, err := actions.NewContextFromPath(path, nil)
if err != nil {
return err
}
policy, err := actions.GetPolicyFromPath(ctx, path)
if err != nil {
return err
}
fmt.Fprintf(w, "%q is encrypted with fscrypt.\n", path)
fmt.Fprintln(w)
fmt.Fprintf(w, "Policy: %s\n", policy.Descriptor())
fmt.Fprintf(w, "Options: %s\n", policy.Options())
fmt.Fprintf(w, "Unlocked: %s\n", policyUnlockedStatus(policy))
fmt.Fprintln(w)
options := policy.ProtectorOptions()
fmt.Fprintf(w, "Protected with %s:\n", pluralize(len(options), "protector"))
writeOptions(w, options)
return nil
}
|
